diff --git a/.nvmrc b/.nvmrc index 92c8236..1be7c05 100644 --- a/.nvmrc +++ b/.nvmrc @@ -1 +1 @@ -10.8.0 \ No newline at end of file +v10.15.3 \ No newline at end of file diff --git a/README.md b/README.md index 9bca189..4488208 100644 --- a/README.md +++ b/README.md @@ -274,7 +274,7 @@ _Query:_ ```js import Traveler from 'the-traveler'; -import {ComponentType} from 'the-traveler/build/enums' +import {ComponentType} from 'the-traveler/type-definitions/destiny2'; const traveler = new Traveler({ apikey: 'pasteYourAPIkey', diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js index 3c2fffd..8084ac7 100644 --- a/docs/assets/js/search.js +++ b/docs/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","32":"Variable","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal"},"rows":[{"id":0,"kind":128,"name":"BungieResource","url":"classes/bungieresource.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"httpService","url":"classes/bungieresource.html#httpservice","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"BungieResource"},{"id":2,"kind":1024,"name":"basePath","url":"classes/bungieresource.html#basepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"BungieResource"},{"id":3,"kind":1024,"name":"resourcePath","url":"classes/bungieresource.html#resourcepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"BungieResource"},{"id":4,"kind":512,"name":"constructor","url":"classes/bungieresource.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"BungieResource"},{"id":5,"kind":256,"name":"IServerResponse","url":"interfaces/iserverresponse.html","classes":"tsd-kind-interface tsd-has-type-parameter"},{"id":6,"kind":1024,"name":"Response","url":"interfaces/iserverresponse.html#response","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IServerResponse"},{"id":7,"kind":1024,"name":"ErrorCode","url":"interfaces/iserverresponse.html#errorcode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IServerResponse"},{"id":8,"kind":1024,"name":"ThrottleSeconds","url":"interfaces/iserverresponse.html#throttleseconds","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IServerResponse"},{"id":9,"kind":1024,"name":"ErrorStatus","url":"interfaces/iserverresponse.html#errorstatus","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IServerResponse"},{"id":10,"kind":1024,"name":"Message","url":"interfaces/iserverresponse.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IServerResponse"},{"id":11,"kind":1024,"name":"MessageData","url":"interfaces/iserverresponse.html#messagedata","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IServerResponse"},{"id":12,"kind":65536,"name":"__type","url":"interfaces/iserverresponse.html#messagedata.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IServerResponse.MessageData"},{"id":13,"kind":256,"name":"IDateRange","url":"interfaces/idaterange.html","classes":"tsd-kind-interface"},{"id":14,"kind":1024,"name":"start","url":"interfaces/idaterange.html#start","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IDateRange"},{"id":15,"kind":1024,"name":"end","url":"interfaces/idaterange.html#end","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IDateRange"},{"id":16,"kind":4,"name":"PlatformErrorCodes","url":"enums/platformerrorcodes.html","classes":"tsd-kind-enum"},{"id":17,"kind":16,"name":"None","url":"enums/platformerrorcodes.html#none","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":18,"kind":16,"name":"Success","url":"enums/platformerrorcodes.html#success","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":19,"kind":16,"name":"TransportException","url":"enums/platformerrorcodes.html#transportexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":20,"kind":16,"name":"UnhandledException","url":"enums/platformerrorcodes.html#unhandledexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":21,"kind":16,"name":"NotImplemented","url":"enums/platformerrorcodes.html#notimplemented","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":22,"kind":16,"name":"SystemDisabled","url":"enums/platformerrorcodes.html#systemdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":23,"kind":16,"name":"FailedToLoadAvailableLocalesConfiguration","url":"enums/platformerrorcodes.html#failedtoloadavailablelocalesconfiguration","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":24,"kind":16,"name":"ParameterParseFailure","url":"enums/platformerrorcodes.html#parameterparsefailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":25,"kind":16,"name":"ParameterInvalidRange","url":"enums/platformerrorcodes.html#parameterinvalidrange","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":26,"kind":16,"name":"BadRequest","url":"enums/platformerrorcodes.html#badrequest","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":27,"kind":16,"name":"AuthenticationInvalid","url":"enums/platformerrorcodes.html#authenticationinvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":28,"kind":16,"name":"DataNotFound","url":"enums/platformerrorcodes.html#datanotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":29,"kind":16,"name":"InsufficientPrivileges","url":"enums/platformerrorcodes.html#insufficientprivileges","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":30,"kind":16,"name":"Duplicate","url":"enums/platformerrorcodes.html#duplicate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":31,"kind":16,"name":"UnknownSqlResult","url":"enums/platformerrorcodes.html#unknownsqlresult","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":32,"kind":16,"name":"ValidationError","url":"enums/platformerrorcodes.html#validationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":33,"kind":16,"name":"ValidationMissingFieldError","url":"enums/platformerrorcodes.html#validationmissingfielderror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":34,"kind":16,"name":"ValidationInvalidInputError","url":"enums/platformerrorcodes.html#validationinvalidinputerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":35,"kind":16,"name":"InvalidParameters","url":"enums/platformerrorcodes.html#invalidparameters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":36,"kind":16,"name":"ParameterNotFound","url":"enums/platformerrorcodes.html#parameternotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":37,"kind":16,"name":"UnhandledHttpException","url":"enums/platformerrorcodes.html#unhandledhttpexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":38,"kind":16,"name":"NotFound","url":"enums/platformerrorcodes.html#notfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":39,"kind":16,"name":"WebAuthModuleAsyncFailed","url":"enums/platformerrorcodes.html#webauthmoduleasyncfailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":40,"kind":16,"name":"InvalidReturnValue","url":"enums/platformerrorcodes.html#invalidreturnvalue","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":41,"kind":16,"name":"UserBanned","url":"enums/platformerrorcodes.html#userbanned","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":42,"kind":16,"name":"InvalidPostBody","url":"enums/platformerrorcodes.html#invalidpostbody","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":43,"kind":16,"name":"MissingPostBody","url":"enums/platformerrorcodes.html#missingpostbody","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":44,"kind":16,"name":"ExternalServiceTimeout","url":"enums/platformerrorcodes.html#externalservicetimeout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":45,"kind":16,"name":"ValidationLengthError","url":"enums/platformerrorcodes.html#validationlengtherror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":46,"kind":16,"name":"ValidationRangeError","url":"enums/platformerrorcodes.html#validationrangeerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":47,"kind":16,"name":"JsonDeserializationError","url":"enums/platformerrorcodes.html#jsondeserializationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":48,"kind":16,"name":"ThrottleLimitExceeded","url":"enums/platformerrorcodes.html#throttlelimitexceeded","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":49,"kind":16,"name":"ValidationTagError","url":"enums/platformerrorcodes.html#validationtagerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":50,"kind":16,"name":"ValidationProfanityError","url":"enums/platformerrorcodes.html#validationprofanityerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":51,"kind":16,"name":"ValidationUrlFormatError","url":"enums/platformerrorcodes.html#validationurlformaterror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":52,"kind":16,"name":"ThrottleLimitExceededMinutes","url":"enums/platformerrorcodes.html#throttlelimitexceededminutes","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":53,"kind":16,"name":"ThrottleLimitExceededMomentarily","url":"enums/platformerrorcodes.html#throttlelimitexceededmomentarily","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":54,"kind":16,"name":"ThrottleLimitExceededSeconds","url":"enums/platformerrorcodes.html#throttlelimitexceededseconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":55,"kind":16,"name":"ExternalServiceUnknown","url":"enums/platformerrorcodes.html#externalserviceunknown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":56,"kind":16,"name":"ValidationWordLengthError","url":"enums/platformerrorcodes.html#validationwordlengtherror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":57,"kind":16,"name":"ValidationInvisibleUnicode","url":"enums/platformerrorcodes.html#validationinvisibleunicode","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":58,"kind":16,"name":"ValidationBadNames","url":"enums/platformerrorcodes.html#validationbadnames","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":59,"kind":16,"name":"ExternalServiceFailed","url":"enums/platformerrorcodes.html#externalservicefailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":60,"kind":16,"name":"ServiceRetired","url":"enums/platformerrorcodes.html#serviceretired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":61,"kind":16,"name":"UnknownSqlException","url":"enums/platformerrorcodes.html#unknownsqlexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":62,"kind":16,"name":"UnsupportedLocale","url":"enums/platformerrorcodes.html#unsupportedlocale","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":63,"kind":16,"name":"InvalidPageNumber","url":"enums/platformerrorcodes.html#invalidpagenumber","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":64,"kind":16,"name":"MaximumPageSizeExceeded","url":"enums/platformerrorcodes.html#maximumpagesizeexceeded","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":65,"kind":16,"name":"ServiceUnsupported","url":"enums/platformerrorcodes.html#serviceunsupported","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":66,"kind":16,"name":"ValidationMaximumUnicodeCombiningCharacters","url":"enums/platformerrorcodes.html#validationmaximumunicodecombiningcharacters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":67,"kind":16,"name":"ValidationMaximumSequentialCarriageReturns","url":"enums/platformerrorcodes.html#validationmaximumsequentialcarriagereturns","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":68,"kind":16,"name":"PerEndpointRequestThrottleExceeded","url":"enums/platformerrorcodes.html#perendpointrequestthrottleexceeded","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":69,"kind":16,"name":"AuthContextCacheAssertion","url":"enums/platformerrorcodes.html#authcontextcacheassertion","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":70,"kind":16,"name":"ExPlatformStringValidationError","url":"enums/platformerrorcodes.html#explatformstringvalidationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":71,"kind":16,"name":"ObsoleteCredentialType","url":"enums/platformerrorcodes.html#obsoletecredentialtype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":72,"kind":16,"name":"UnableToUnPairMobileApp","url":"enums/platformerrorcodes.html#unabletounpairmobileapp","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":73,"kind":16,"name":"UnableToPairMobileApp","url":"enums/platformerrorcodes.html#unabletopairmobileapp","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":74,"kind":16,"name":"CannotUseMobileAuthWithNonMobileProvider","url":"enums/platformerrorcodes.html#cannotusemobileauthwithnonmobileprovider","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":75,"kind":16,"name":"MissingDeviceCookie","url":"enums/platformerrorcodes.html#missingdevicecookie","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":76,"kind":16,"name":"FacebookTokenExpired","url":"enums/platformerrorcodes.html#facebooktokenexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":77,"kind":16,"name":"AuthTicketRequired","url":"enums/platformerrorcodes.html#authticketrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":78,"kind":16,"name":"CookieContextRequired","url":"enums/platformerrorcodes.html#cookiecontextrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":79,"kind":16,"name":"UnknownAuthenticationError","url":"enums/platformerrorcodes.html#unknownauthenticationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":80,"kind":16,"name":"BungieNetAccountCreationRequired","url":"enums/platformerrorcodes.html#bungienetaccountcreationrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":81,"kind":16,"name":"WebAuthRequired","url":"enums/platformerrorcodes.html#webauthrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":82,"kind":16,"name":"ContentUnknownSqlResult","url":"enums/platformerrorcodes.html#contentunknownsqlresult","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":83,"kind":16,"name":"ContentNeedUniquePath","url":"enums/platformerrorcodes.html#contentneeduniquepath","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":84,"kind":16,"name":"ContentSqlException","url":"enums/platformerrorcodes.html#contentsqlexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":85,"kind":16,"name":"ContentNotFound","url":"enums/platformerrorcodes.html#contentnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":86,"kind":16,"name":"ContentSuccessWithTagAddFail","url":"enums/platformerrorcodes.html#contentsuccesswithtagaddfail","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":87,"kind":16,"name":"ContentSearchMissingParameters","url":"enums/platformerrorcodes.html#contentsearchmissingparameters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":88,"kind":16,"name":"ContentInvalidId","url":"enums/platformerrorcodes.html#contentinvalidid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":89,"kind":16,"name":"ContentPhysicalFileDeletionError","url":"enums/platformerrorcodes.html#contentphysicalfiledeletionerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":90,"kind":16,"name":"ContentPhysicalFileCreationError","url":"enums/platformerrorcodes.html#contentphysicalfilecreationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":91,"kind":16,"name":"ContentPerforceSubmissionError","url":"enums/platformerrorcodes.html#contentperforcesubmissionerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":92,"kind":16,"name":"ContentPerforceInitializationError","url":"enums/platformerrorcodes.html#contentperforceinitializationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":93,"kind":16,"name":"ContentDeploymentPackageNotReadyError","url":"enums/platformerrorcodes.html#contentdeploymentpackagenotreadyerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":94,"kind":16,"name":"ContentUploadFailed","url":"enums/platformerrorcodes.html#contentuploadfailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":95,"kind":16,"name":"ContentTooManyResults","url":"enums/platformerrorcodes.html#contenttoomanyresults","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":96,"kind":16,"name":"ContentInvalidState","url":"enums/platformerrorcodes.html#contentinvalidstate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":97,"kind":16,"name":"ContentNavigationParentNotFound","url":"enums/platformerrorcodes.html#contentnavigationparentnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":98,"kind":16,"name":"ContentNavigationParentUpdateError","url":"enums/platformerrorcodes.html#contentnavigationparentupdateerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":99,"kind":16,"name":"DeploymentPackageNotEditable","url":"enums/platformerrorcodes.html#deploymentpackagenoteditable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":100,"kind":16,"name":"ContentValidationError","url":"enums/platformerrorcodes.html#contentvalidationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":101,"kind":16,"name":"ContentPropertiesValidationError","url":"enums/platformerrorcodes.html#contentpropertiesvalidationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":102,"kind":16,"name":"ContentTypeNotFound","url":"enums/platformerrorcodes.html#contenttypenotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":103,"kind":16,"name":"DeploymentPackageNotFound","url":"enums/platformerrorcodes.html#deploymentpackagenotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":104,"kind":16,"name":"ContentSearchInvalidParameters","url":"enums/platformerrorcodes.html#contentsearchinvalidparameters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":105,"kind":16,"name":"ContentItemPropertyAggregationError","url":"enums/platformerrorcodes.html#contentitempropertyaggregationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":106,"kind":16,"name":"DeploymentPackageFileNotFound","url":"enums/platformerrorcodes.html#deploymentpackagefilenotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":107,"kind":16,"name":"ContentPerforceFileHistoryNotFound","url":"enums/platformerrorcodes.html#contentperforcefilehistorynotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":108,"kind":16,"name":"ContentAssetZipCreationFailure","url":"enums/platformerrorcodes.html#contentassetzipcreationfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":109,"kind":16,"name":"ContentAssetZipCreationBusy","url":"enums/platformerrorcodes.html#contentassetzipcreationbusy","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":110,"kind":16,"name":"ContentProjectNotFound","url":"enums/platformerrorcodes.html#contentprojectnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":111,"kind":16,"name":"ContentFolderNotFound","url":"enums/platformerrorcodes.html#contentfoldernotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":112,"kind":16,"name":"ContentPackagesInconsistent","url":"enums/platformerrorcodes.html#contentpackagesinconsistent","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":113,"kind":16,"name":"ContentPackagesInvalidState","url":"enums/platformerrorcodes.html#contentpackagesinvalidstate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":114,"kind":16,"name":"ContentPackagesInconsistentType","url":"enums/platformerrorcodes.html#contentpackagesinconsistenttype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":115,"kind":16,"name":"ContentCannotDeletePackage","url":"enums/platformerrorcodes.html#contentcannotdeletepackage","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":116,"kind":16,"name":"ContentLockedForChanges","url":"enums/platformerrorcodes.html#contentlockedforchanges","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":117,"kind":16,"name":"ContentFileUploadFailed","url":"enums/platformerrorcodes.html#contentfileuploadfailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":118,"kind":16,"name":"ContentNotReviewed","url":"enums/platformerrorcodes.html#contentnotreviewed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":119,"kind":16,"name":"ContentPermissionDenied","url":"enums/platformerrorcodes.html#contentpermissiondenied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":120,"kind":16,"name":"ContentInvalidExternalUrl","url":"enums/platformerrorcodes.html#contentinvalidexternalurl","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":121,"kind":16,"name":"ContentExternalFileCannotBeImportedLocally","url":"enums/platformerrorcodes.html#contentexternalfilecannotbeimportedlocally","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":122,"kind":16,"name":"ContentTagSaveFailure","url":"enums/platformerrorcodes.html#contenttagsavefailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":123,"kind":16,"name":"ContentPerforceUnmatchedFileError","url":"enums/platformerrorcodes.html#contentperforceunmatchedfileerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":124,"kind":16,"name":"ContentPerforceChangelistResultNotFound","url":"enums/platformerrorcodes.html#contentperforcechangelistresultnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":125,"kind":16,"name":"ContentPerforceChangelistFileItemsNotFound","url":"enums/platformerrorcodes.html#contentperforcechangelistfileitemsnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":126,"kind":16,"name":"ContentPerforceInvalidRevisionError","url":"enums/platformerrorcodes.html#contentperforceinvalidrevisionerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":127,"kind":16,"name":"ContentUnloadedSaveResult","url":"enums/platformerrorcodes.html#contentunloadedsaveresult","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":128,"kind":16,"name":"ContentPropertyInvalidNumber","url":"enums/platformerrorcodes.html#contentpropertyinvalidnumber","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":129,"kind":16,"name":"ContentPropertyInvalidUrl","url":"enums/platformerrorcodes.html#contentpropertyinvalidurl","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":130,"kind":16,"name":"ContentPropertyInvalidDate","url":"enums/platformerrorcodes.html#contentpropertyinvaliddate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":131,"kind":16,"name":"ContentPropertyInvalidSet","url":"enums/platformerrorcodes.html#contentpropertyinvalidset","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":132,"kind":16,"name":"ContentPropertyCannotDeserialize","url":"enums/platformerrorcodes.html#contentpropertycannotdeserialize","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":133,"kind":16,"name":"ContentRegexValidationFailOnProperty","url":"enums/platformerrorcodes.html#contentregexvalidationfailonproperty","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":134,"kind":16,"name":"ContentMaxLengthFailOnProperty","url":"enums/platformerrorcodes.html#contentmaxlengthfailonproperty","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":135,"kind":16,"name":"ContentPropertyUnexpectedDeserializationError","url":"enums/platformerrorcodes.html#contentpropertyunexpecteddeserializationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":136,"kind":16,"name":"ContentPropertyRequired","url":"enums/platformerrorcodes.html#contentpropertyrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":137,"kind":16,"name":"ContentCannotCreateFile","url":"enums/platformerrorcodes.html#contentcannotcreatefile","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":138,"kind":16,"name":"ContentInvalidMigrationFile","url":"enums/platformerrorcodes.html#contentinvalidmigrationfile","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":139,"kind":16,"name":"ContentMigrationAlteringProcessedItem","url":"enums/platformerrorcodes.html#contentmigrationalteringprocesseditem","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":140,"kind":16,"name":"ContentPropertyDefinitionNotFound","url":"enums/platformerrorcodes.html#contentpropertydefinitionnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":141,"kind":16,"name":"ContentReviewDataChanged","url":"enums/platformerrorcodes.html#contentreviewdatachanged","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":142,"kind":16,"name":"ContentRollbackRevisionNotInPackage","url":"enums/platformerrorcodes.html#contentrollbackrevisionnotinpackage","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":143,"kind":16,"name":"ContentItemNotBasedOnLatestRevision","url":"enums/platformerrorcodes.html#contentitemnotbasedonlatestrevision","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":144,"kind":16,"name":"ContentUnauthorized","url":"enums/platformerrorcodes.html#contentunauthorized","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":145,"kind":16,"name":"ContentCannotCreateDeploymentPackage","url":"enums/platformerrorcodes.html#contentcannotcreatedeploymentpackage","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":146,"kind":16,"name":"ContentUserNotFound","url":"enums/platformerrorcodes.html#contentusernotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":147,"kind":16,"name":"ContentLocalePermissionDenied","url":"enums/platformerrorcodes.html#contentlocalepermissiondenied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":148,"kind":16,"name":"ContentInvalidLinkToInternalEnvironment","url":"enums/platformerrorcodes.html#contentinvalidlinktointernalenvironment","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":149,"kind":16,"name":"ContentInvalidBlacklistedContent","url":"enums/platformerrorcodes.html#contentinvalidblacklistedcontent","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":150,"kind":16,"name":"ContentMacroMalformedNoContentId","url":"enums/platformerrorcodes.html#contentmacromalformednocontentid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":151,"kind":16,"name":"ContentMacroMalformedNoTemplateType","url":"enums/platformerrorcodes.html#contentmacromalformednotemplatetype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":152,"kind":16,"name":"ContentIllegalBNetMembershipId","url":"enums/platformerrorcodes.html#contentillegalbnetmembershipid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":153,"kind":16,"name":"ContentLocaleDidNotMatchExpected","url":"enums/platformerrorcodes.html#contentlocaledidnotmatchexpected","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":154,"kind":16,"name":"ContentBabelCallFailed","url":"enums/platformerrorcodes.html#contentbabelcallfailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":155,"kind":16,"name":"ContentEnglishPostLiveForbidden","url":"enums/platformerrorcodes.html#contentenglishpostliveforbidden","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":156,"kind":16,"name":"ContentLocaleEditPermissionDenied","url":"enums/platformerrorcodes.html#contentlocaleeditpermissiondenied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":157,"kind":16,"name":"UserNonUniqueName","url":"enums/platformerrorcodes.html#usernonuniquename","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":158,"kind":16,"name":"UserManualLinkingStepRequired","url":"enums/platformerrorcodes.html#usermanuallinkingsteprequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":159,"kind":16,"name":"UserCreateUnknownSqlResult","url":"enums/platformerrorcodes.html#usercreateunknownsqlresult","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":160,"kind":16,"name":"UserCreateUnknownSqlException","url":"enums/platformerrorcodes.html#usercreateunknownsqlexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":161,"kind":16,"name":"UserMalformedMembershipId","url":"enums/platformerrorcodes.html#usermalformedmembershipid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":162,"kind":16,"name":"UserCannotFindRequestedUser","url":"enums/platformerrorcodes.html#usercannotfindrequesteduser","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":163,"kind":16,"name":"UserCannotLoadAccountCredentialLinkInfo","url":"enums/platformerrorcodes.html#usercannotloadaccountcredentiallinkinfo","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":164,"kind":16,"name":"UserInvalidMobileAppType","url":"enums/platformerrorcodes.html#userinvalidmobileapptype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":165,"kind":16,"name":"UserMissingMobilePairingInfo","url":"enums/platformerrorcodes.html#usermissingmobilepairinginfo","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":166,"kind":16,"name":"UserCannotGenerateMobileKeyWhileUsingMobileCredential","url":"enums/platformerrorcodes.html#usercannotgeneratemobilekeywhileusingmobilecredential","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":167,"kind":16,"name":"UserGenerateMobileKeyExistingSlotCollision","url":"enums/platformerrorcodes.html#usergeneratemobilekeyexistingslotcollision","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":168,"kind":16,"name":"UserDisplayNameMissingOrInvalid","url":"enums/platformerrorcodes.html#userdisplaynamemissingorinvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":169,"kind":16,"name":"UserCannotLoadAccountProfileData","url":"enums/platformerrorcodes.html#usercannotloadaccountprofiledata","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":170,"kind":16,"name":"UserCannotSaveUserProfileData","url":"enums/platformerrorcodes.html#usercannotsaveuserprofiledata","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":171,"kind":16,"name":"UserEmailMissingOrInvalid","url":"enums/platformerrorcodes.html#useremailmissingorinvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":172,"kind":16,"name":"UserTermsOfUseRequired","url":"enums/platformerrorcodes.html#usertermsofuserequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":173,"kind":16,"name":"UserCannotCreateNewAccountWhileLoggedIn","url":"enums/platformerrorcodes.html#usercannotcreatenewaccountwhileloggedin","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":174,"kind":16,"name":"UserCannotResolveCentralAccount","url":"enums/platformerrorcodes.html#usercannotresolvecentralaccount","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":175,"kind":16,"name":"UserInvalidAvatar","url":"enums/platformerrorcodes.html#userinvalidavatar","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":176,"kind":16,"name":"UserMissingCreatedUserResult","url":"enums/platformerrorcodes.html#usermissingcreateduserresult","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":177,"kind":16,"name":"UserCannotChangeUniqueNameYet","url":"enums/platformerrorcodes.html#usercannotchangeuniquenameyet","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":178,"kind":16,"name":"UserCannotChangeDisplayNameYet","url":"enums/platformerrorcodes.html#usercannotchangedisplaynameyet","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":179,"kind":16,"name":"UserCannotChangeEmail","url":"enums/platformerrorcodes.html#usercannotchangeemail","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":180,"kind":16,"name":"UserUniqueNameMustStartWithLetter","url":"enums/platformerrorcodes.html#useruniquenamemuststartwithletter","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":181,"kind":16,"name":"UserNoLinkedAccountsSupportFriendListings","url":"enums/platformerrorcodes.html#usernolinkedaccountssupportfriendlistings","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":182,"kind":16,"name":"UserAcknowledgmentTableFull","url":"enums/platformerrorcodes.html#useracknowledgmenttablefull","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":183,"kind":16,"name":"UserCreationDestinyMembershipRequired","url":"enums/platformerrorcodes.html#usercreationdestinymembershiprequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":184,"kind":16,"name":"UserFriendsTokenNeedsRefresh","url":"enums/platformerrorcodes.html#userfriendstokenneedsrefresh","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":185,"kind":16,"name":"MessagingUnknownError","url":"enums/platformerrorcodes.html#messagingunknownerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":186,"kind":16,"name":"MessagingSelfError","url":"enums/platformerrorcodes.html#messagingselferror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":187,"kind":16,"name":"MessagingSendThrottle","url":"enums/platformerrorcodes.html#messagingsendthrottle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":188,"kind":16,"name":"MessagingNoBody","url":"enums/platformerrorcodes.html#messagingnobody","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":189,"kind":16,"name":"MessagingTooManyUsers","url":"enums/platformerrorcodes.html#messagingtoomanyusers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":190,"kind":16,"name":"MessagingCanNotLeaveConversation","url":"enums/platformerrorcodes.html#messagingcannotleaveconversation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":191,"kind":16,"name":"MessagingUnableToSend","url":"enums/platformerrorcodes.html#messagingunabletosend","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":192,"kind":16,"name":"MessagingDeletedUserForbidden","url":"enums/platformerrorcodes.html#messagingdeleteduserforbidden","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":193,"kind":16,"name":"MessagingCannotDeleteExternalConversation","url":"enums/platformerrorcodes.html#messagingcannotdeleteexternalconversation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":194,"kind":16,"name":"MessagingGroupChatDisabled","url":"enums/platformerrorcodes.html#messaginggroupchatdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":195,"kind":16,"name":"MessagingMustIncludeSelfInPrivateMessage","url":"enums/platformerrorcodes.html#messagingmustincludeselfinprivatemessage","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":196,"kind":16,"name":"MessagingSenderIsBanned","url":"enums/platformerrorcodes.html#messagingsenderisbanned","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":197,"kind":16,"name":"MessagingGroupOptionalChatExceededMaximum","url":"enums/platformerrorcodes.html#messaginggroupoptionalchatexceededmaximum","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":198,"kind":16,"name":"PrivateMessagingRequiresDestinyMembership","url":"enums/platformerrorcodes.html#privatemessagingrequiresdestinymembership","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":199,"kind":16,"name":"AddSurveyAnswersUnknownSqlException","url":"enums/platformerrorcodes.html#addsurveyanswersunknownsqlexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":200,"kind":16,"name":"ForumBodyCannotBeEmpty","url":"enums/platformerrorcodes.html#forumbodycannotbeempty","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":201,"kind":16,"name":"ForumSubjectCannotBeEmptyOnTopicPost","url":"enums/platformerrorcodes.html#forumsubjectcannotbeemptyontopicpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":202,"kind":16,"name":"ForumCannotLocateParentPost","url":"enums/platformerrorcodes.html#forumcannotlocateparentpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":203,"kind":16,"name":"ForumThreadLockedForReplies","url":"enums/platformerrorcodes.html#forumthreadlockedforreplies","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":204,"kind":16,"name":"ForumUnknownSqlResultDuringCreatePost","url":"enums/platformerrorcodes.html#forumunknownsqlresultduringcreatepost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":205,"kind":16,"name":"ForumUnknownTagCreationError","url":"enums/platformerrorcodes.html#forumunknowntagcreationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":206,"kind":16,"name":"ForumUnknownSqlResultDuringTagItem","url":"enums/platformerrorcodes.html#forumunknownsqlresultduringtagitem","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":207,"kind":16,"name":"ForumUnknownExceptionCreatePost","url":"enums/platformerrorcodes.html#forumunknownexceptioncreatepost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":208,"kind":16,"name":"ForumQuestionMustBeTopicPost","url":"enums/platformerrorcodes.html#forumquestionmustbetopicpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":209,"kind":16,"name":"ForumExceptionDuringTagSearch","url":"enums/platformerrorcodes.html#forumexceptionduringtagsearch","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":210,"kind":16,"name":"ForumExceptionDuringTopicRetrieval","url":"enums/platformerrorcodes.html#forumexceptionduringtopicretrieval","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":211,"kind":16,"name":"ForumAliasedTagError","url":"enums/platformerrorcodes.html#forumaliasedtagerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":212,"kind":16,"name":"ForumCannotLocateThread","url":"enums/platformerrorcodes.html#forumcannotlocatethread","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":213,"kind":16,"name":"ForumUnknownExceptionEditPost","url":"enums/platformerrorcodes.html#forumunknownexceptioneditpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":214,"kind":16,"name":"ForumCannotLocatePost","url":"enums/platformerrorcodes.html#forumcannotlocatepost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":215,"kind":16,"name":"ForumUnknownExceptionGetOrCreateTags","url":"enums/platformerrorcodes.html#forumunknownexceptiongetorcreatetags","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":216,"kind":16,"name":"ForumEditPermissionDenied","url":"enums/platformerrorcodes.html#forumeditpermissiondenied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":217,"kind":16,"name":"ForumUnknownSqlResultDuringTagIdRetrieval","url":"enums/platformerrorcodes.html#forumunknownsqlresultduringtagidretrieval","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":218,"kind":16,"name":"ForumCannotGetRating","url":"enums/platformerrorcodes.html#forumcannotgetrating","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":219,"kind":16,"name":"ForumUnknownExceptionGetRating","url":"enums/platformerrorcodes.html#forumunknownexceptiongetrating","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":220,"kind":16,"name":"ForumRatingsAccessError","url":"enums/platformerrorcodes.html#forumratingsaccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":221,"kind":16,"name":"ForumRelatedPostAccessError","url":"enums/platformerrorcodes.html#forumrelatedpostaccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":222,"kind":16,"name":"ForumLatestReplyAccessError","url":"enums/platformerrorcodes.html#forumlatestreplyaccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":223,"kind":16,"name":"ForumUserStatusAccessError","url":"enums/platformerrorcodes.html#forumuserstatusaccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":224,"kind":16,"name":"ForumAuthorAccessError","url":"enums/platformerrorcodes.html#forumauthoraccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":225,"kind":16,"name":"ForumGroupAccessError","url":"enums/platformerrorcodes.html#forumgroupaccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":226,"kind":16,"name":"ForumUrlExpectedButMissing","url":"enums/platformerrorcodes.html#forumurlexpectedbutmissing","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":227,"kind":16,"name":"ForumRepliesCannotBeEmpty","url":"enums/platformerrorcodes.html#forumrepliescannotbeempty","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":228,"kind":16,"name":"ForumRepliesCannotBeInDifferentGroups","url":"enums/platformerrorcodes.html#forumrepliescannotbeindifferentgroups","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":229,"kind":16,"name":"ForumSubTopicCannotBeCreatedAtThisThreadLevel","url":"enums/platformerrorcodes.html#forumsubtopiccannotbecreatedatthisthreadlevel","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":230,"kind":16,"name":"ForumCannotCreateContentTopic","url":"enums/platformerrorcodes.html#forumcannotcreatecontenttopic","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":231,"kind":16,"name":"ForumTopicDoesNotExist","url":"enums/platformerrorcodes.html#forumtopicdoesnotexist","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":232,"kind":16,"name":"ForumContentCommentsNotAllowed","url":"enums/platformerrorcodes.html#forumcontentcommentsnotallowed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":233,"kind":16,"name":"ForumUnknownSqlResultDuringEditPost","url":"enums/platformerrorcodes.html#forumunknownsqlresultduringeditpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":234,"kind":16,"name":"ForumUnknownSqlResultDuringGetPost","url":"enums/platformerrorcodes.html#forumunknownsqlresultduringgetpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":235,"kind":16,"name":"ForumPostValidationBadUrl","url":"enums/platformerrorcodes.html#forumpostvalidationbadurl","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":236,"kind":16,"name":"ForumBodyTooLong","url":"enums/platformerrorcodes.html#forumbodytoolong","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":237,"kind":16,"name":"ForumSubjectTooLong","url":"enums/platformerrorcodes.html#forumsubjecttoolong","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":238,"kind":16,"name":"ForumAnnouncementNotAllowed","url":"enums/platformerrorcodes.html#forumannouncementnotallowed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":239,"kind":16,"name":"ForumCannotShareOwnPost","url":"enums/platformerrorcodes.html#forumcannotshareownpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":240,"kind":16,"name":"ForumEditNoOp","url":"enums/platformerrorcodes.html#forumeditnoop","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":241,"kind":16,"name":"ForumUnknownDatabaseErrorDuringGetPost","url":"enums/platformerrorcodes.html#forumunknowndatabaseerrorduringgetpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":242,"kind":16,"name":"ForumExceeedMaximumRowLimit","url":"enums/platformerrorcodes.html#forumexceeedmaximumrowlimit","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":243,"kind":16,"name":"ForumCannotSharePrivatePost","url":"enums/platformerrorcodes.html#forumcannotshareprivatepost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":244,"kind":16,"name":"ForumCannotCrossPostBetweenGroups","url":"enums/platformerrorcodes.html#forumcannotcrosspostbetweengroups","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":245,"kind":16,"name":"ForumIncompatibleCategories","url":"enums/platformerrorcodes.html#forumincompatiblecategories","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":246,"kind":16,"name":"ForumCannotUseTheseCategoriesOnNonTopicPost","url":"enums/platformerrorcodes.html#forumcannotusethesecategoriesonnontopicpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":247,"kind":16,"name":"ForumCanOnlyDeleteTopics","url":"enums/platformerrorcodes.html#forumcanonlydeletetopics","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":248,"kind":16,"name":"ForumDeleteSqlException","url":"enums/platformerrorcodes.html#forumdeletesqlexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":249,"kind":16,"name":"ForumDeleteSqlUnknownResult","url":"enums/platformerrorcodes.html#forumdeletesqlunknownresult","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":250,"kind":16,"name":"ForumTooManyTags","url":"enums/platformerrorcodes.html#forumtoomanytags","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":251,"kind":16,"name":"ForumCanOnlyRateTopics","url":"enums/platformerrorcodes.html#forumcanonlyratetopics","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":252,"kind":16,"name":"ForumBannedPostsCannotBeEdited","url":"enums/platformerrorcodes.html#forumbannedpostscannotbeedited","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":253,"kind":16,"name":"ForumThreadRootIsBanned","url":"enums/platformerrorcodes.html#forumthreadrootisbanned","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":254,"kind":16,"name":"ForumCannotUseOfficialTagCategoryAsTag","url":"enums/platformerrorcodes.html#forumcannotuseofficialtagcategoryastag","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":255,"kind":16,"name":"ForumAnswerCannotBeMadeOnCreatePost","url":"enums/platformerrorcodes.html#forumanswercannotbemadeoncreatepost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":256,"kind":16,"name":"ForumAnswerCannotBeMadeOnEditPost","url":"enums/platformerrorcodes.html#forumanswercannotbemadeoneditpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":257,"kind":16,"name":"ForumAnswerPostIdIsNotADirectReplyOfQuestion","url":"enums/platformerrorcodes.html#forumanswerpostidisnotadirectreplyofquestion","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":258,"kind":16,"name":"ForumAnswerTopicIdIsNotAQuestion","url":"enums/platformerrorcodes.html#forumanswertopicidisnotaquestion","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":259,"kind":16,"name":"ForumUnknownExceptionDuringMarkAnswer","url":"enums/platformerrorcodes.html#forumunknownexceptionduringmarkanswer","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":260,"kind":16,"name":"ForumUnknownSqlResultDuringMarkAnswer","url":"enums/platformerrorcodes.html#forumunknownsqlresultduringmarkanswer","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":261,"kind":16,"name":"ForumCannotRateYourOwnPosts","url":"enums/platformerrorcodes.html#forumcannotrateyourownposts","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":262,"kind":16,"name":"ForumPollsMustBeTheFirstPostInTopic","url":"enums/platformerrorcodes.html#forumpollsmustbethefirstpostintopic","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":263,"kind":16,"name":"ForumInvalidPollInput","url":"enums/platformerrorcodes.html#foruminvalidpollinput","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":264,"kind":16,"name":"ForumGroupAdminEditNonMember","url":"enums/platformerrorcodes.html#forumgroupadmineditnonmember","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":265,"kind":16,"name":"ForumCannotEditModeratorEditedPost","url":"enums/platformerrorcodes.html#forumcannoteditmoderatoreditedpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":266,"kind":16,"name":"ForumRequiresDestinyMembership","url":"enums/platformerrorcodes.html#forumrequiresdestinymembership","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":267,"kind":16,"name":"ForumUnexpectedError","url":"enums/platformerrorcodes.html#forumunexpectederror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":268,"kind":16,"name":"ForumAgeLock","url":"enums/platformerrorcodes.html#forumagelock","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":269,"kind":16,"name":"ForumMaxPages","url":"enums/platformerrorcodes.html#forummaxpages","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":270,"kind":16,"name":"ForumMaxPagesOldestFirst","url":"enums/platformerrorcodes.html#forummaxpagesoldestfirst","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":271,"kind":16,"name":"ForumCannotApplyForumIdWithoutTags","url":"enums/platformerrorcodes.html#forumcannotapplyforumidwithouttags","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":272,"kind":16,"name":"ForumCannotApplyForumIdToNonTopics","url":"enums/platformerrorcodes.html#forumcannotapplyforumidtonontopics","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":273,"kind":16,"name":"ForumCannotDownvoteCommunityCreations","url":"enums/platformerrorcodes.html#forumcannotdownvotecommunitycreations","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":274,"kind":16,"name":"ForumTopicsMustHaveOfficialCategory","url":"enums/platformerrorcodes.html#forumtopicsmusthaveofficialcategory","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":275,"kind":16,"name":"ForumRecruitmentTopicMalformed","url":"enums/platformerrorcodes.html#forumrecruitmenttopicmalformed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":276,"kind":16,"name":"ForumRecruitmentTopicNotFound","url":"enums/platformerrorcodes.html#forumrecruitmenttopicnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":277,"kind":16,"name":"ForumRecruitmentTopicNoSlotsRemaining","url":"enums/platformerrorcodes.html#forumrecruitmenttopicnoslotsremaining","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":278,"kind":16,"name":"ForumRecruitmentTopicKickBan","url":"enums/platformerrorcodes.html#forumrecruitmenttopickickban","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":279,"kind":16,"name":"ForumRecruitmentTopicRequirementsNotMet","url":"enums/platformerrorcodes.html#forumrecruitmenttopicrequirementsnotmet","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":280,"kind":16,"name":"ForumRecruitmentTopicNoPlayers","url":"enums/platformerrorcodes.html#forumrecruitmenttopicnoplayers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":281,"kind":16,"name":"ForumRecruitmentApproveFailMessageBan","url":"enums/platformerrorcodes.html#forumrecruitmentapprovefailmessageban","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":282,"kind":16,"name":"ForumRecruitmentGlobalBan","url":"enums/platformerrorcodes.html#forumrecruitmentglobalban","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":283,"kind":16,"name":"ForumUserBannedFromThisTopic","url":"enums/platformerrorcodes.html#forumuserbannedfromthistopic","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":284,"kind":16,"name":"ForumRecruitmentFireteamMembersOnly","url":"enums/platformerrorcodes.html#forumrecruitmentfireteammembersonly","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":285,"kind":16,"name":"ForumRequiresDestiny2Progress","url":"enums/platformerrorcodes.html#forumrequiresdestiny2progress","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":286,"kind":16,"name":"GroupMembershipApplicationAlreadyResolved","url":"enums/platformerrorcodes.html#groupmembershipapplicationalreadyresolved","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":287,"kind":16,"name":"GroupMembershipAlreadyApplied","url":"enums/platformerrorcodes.html#groupmembershipalreadyapplied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":288,"kind":16,"name":"GroupMembershipInsufficientPrivileges","url":"enums/platformerrorcodes.html#groupmembershipinsufficientprivileges","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":289,"kind":16,"name":"GroupIdNotReturnedFromCreation","url":"enums/platformerrorcodes.html#groupidnotreturnedfromcreation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":290,"kind":16,"name":"GroupSearchInvalidParameters","url":"enums/platformerrorcodes.html#groupsearchinvalidparameters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":291,"kind":16,"name":"GroupMembershipPendingApplicationNotFound","url":"enums/platformerrorcodes.html#groupmembershippendingapplicationnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":292,"kind":16,"name":"GroupInvalidId","url":"enums/platformerrorcodes.html#groupinvalidid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":293,"kind":16,"name":"GroupInvalidMembershipId","url":"enums/platformerrorcodes.html#groupinvalidmembershipid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":294,"kind":16,"name":"GroupInvalidMembershipType","url":"enums/platformerrorcodes.html#groupinvalidmembershiptype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":295,"kind":16,"name":"GroupMissingTags","url":"enums/platformerrorcodes.html#groupmissingtags","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":296,"kind":16,"name":"GroupMembershipNotFound","url":"enums/platformerrorcodes.html#groupmembershipnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":297,"kind":16,"name":"GroupInvalidRating","url":"enums/platformerrorcodes.html#groupinvalidrating","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":298,"kind":16,"name":"GroupUserFollowingAccessError","url":"enums/platformerrorcodes.html#groupuserfollowingaccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":299,"kind":16,"name":"GroupUserMembershipAccessError","url":"enums/platformerrorcodes.html#groupusermembershipaccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":300,"kind":16,"name":"GroupCreatorAccessError","url":"enums/platformerrorcodes.html#groupcreatoraccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":301,"kind":16,"name":"GroupAdminAccessError","url":"enums/platformerrorcodes.html#groupadminaccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":302,"kind":16,"name":"GroupPrivatePostNotViewable","url":"enums/platformerrorcodes.html#groupprivatepostnotviewable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":303,"kind":16,"name":"GroupMembershipNotLoggedIn","url":"enums/platformerrorcodes.html#groupmembershipnotloggedin","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":304,"kind":16,"name":"GroupNotDeleted","url":"enums/platformerrorcodes.html#groupnotdeleted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":305,"kind":16,"name":"GroupUnknownErrorUndeletingGroup","url":"enums/platformerrorcodes.html#groupunknownerrorundeletinggroup","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":306,"kind":16,"name":"GroupDeleted","url":"enums/platformerrorcodes.html#groupdeleted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":307,"kind":16,"name":"GroupNotFound","url":"enums/platformerrorcodes.html#groupnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":308,"kind":16,"name":"GroupMemberBanned","url":"enums/platformerrorcodes.html#groupmemberbanned","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":309,"kind":16,"name":"GroupMembershipClosed","url":"enums/platformerrorcodes.html#groupmembershipclosed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":310,"kind":16,"name":"GroupPrivatePostOverrideError","url":"enums/platformerrorcodes.html#groupprivatepostoverrideerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":311,"kind":16,"name":"GroupNameTaken","url":"enums/platformerrorcodes.html#groupnametaken","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":312,"kind":16,"name":"GroupDeletionGracePeriodExpired","url":"enums/platformerrorcodes.html#groupdeletiongraceperiodexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":313,"kind":16,"name":"GroupCannotCheckBanStatus","url":"enums/platformerrorcodes.html#groupcannotcheckbanstatus","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":314,"kind":16,"name":"GroupMaximumMembershipCountReached","url":"enums/platformerrorcodes.html#groupmaximummembershipcountreached","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":315,"kind":16,"name":"NoDestinyAccountForClanPlatform","url":"enums/platformerrorcodes.html#nodestinyaccountforclanplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":316,"kind":16,"name":"AlreadyRequestingMembershipForClanPlatform","url":"enums/platformerrorcodes.html#alreadyrequestingmembershipforclanplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":317,"kind":16,"name":"AlreadyClanMemberOnPlatform","url":"enums/platformerrorcodes.html#alreadyclanmemberonplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":318,"kind":16,"name":"GroupJoinedCannotSetClanName","url":"enums/platformerrorcodes.html#groupjoinedcannotsetclanname","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":319,"kind":16,"name":"GroupLeftCannotClearClanName","url":"enums/platformerrorcodes.html#groupleftcannotclearclanname","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":320,"kind":16,"name":"GroupRelationshipRequestPending","url":"enums/platformerrorcodes.html#grouprelationshiprequestpending","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":321,"kind":16,"name":"GroupRelationshipRequestBlocked","url":"enums/platformerrorcodes.html#grouprelationshiprequestblocked","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":322,"kind":16,"name":"GroupRelationshipRequestNotFound","url":"enums/platformerrorcodes.html#grouprelationshiprequestnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":323,"kind":16,"name":"GroupRelationshipBlockNotFound","url":"enums/platformerrorcodes.html#grouprelationshipblocknotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":324,"kind":16,"name":"GroupRelationshipNotFound","url":"enums/platformerrorcodes.html#grouprelationshipnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":325,"kind":16,"name":"GroupAlreadyAllied","url":"enums/platformerrorcodes.html#groupalreadyallied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":326,"kind":16,"name":"GroupAlreadyMember","url":"enums/platformerrorcodes.html#groupalreadymember","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":327,"kind":16,"name":"GroupRelationshipAlreadyExists","url":"enums/platformerrorcodes.html#grouprelationshipalreadyexists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":328,"kind":16,"name":"InvalidGroupTypesForRelationshipRequest","url":"enums/platformerrorcodes.html#invalidgrouptypesforrelationshiprequest","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":329,"kind":16,"name":"GroupAtMaximumAlliances","url":"enums/platformerrorcodes.html#groupatmaximumalliances","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":330,"kind":16,"name":"GroupCannotSetClanOnlySettings","url":"enums/platformerrorcodes.html#groupcannotsetclanonlysettings","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":331,"kind":16,"name":"ClanCannotSetTwoDefaultPostTypes","url":"enums/platformerrorcodes.html#clancannotsettwodefaultposttypes","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":332,"kind":16,"name":"GroupMemberInvalidMemberType","url":"enums/platformerrorcodes.html#groupmemberinvalidmembertype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":333,"kind":16,"name":"GroupInvalidPlatformType","url":"enums/platformerrorcodes.html#groupinvalidplatformtype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":334,"kind":16,"name":"GroupMemberInvalidSort","url":"enums/platformerrorcodes.html#groupmemberinvalidsort","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":335,"kind":16,"name":"GroupInvalidResolveState","url":"enums/platformerrorcodes.html#groupinvalidresolvestate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":336,"kind":16,"name":"ClanAlreadyEnabledForPlatform","url":"enums/platformerrorcodes.html#clanalreadyenabledforplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":337,"kind":16,"name":"ClanNotEnabledForPlatform","url":"enums/platformerrorcodes.html#clannotenabledforplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":338,"kind":16,"name":"ClanEnabledButCouldNotJoinNoAccount","url":"enums/platformerrorcodes.html#clanenabledbutcouldnotjoinnoaccount","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":339,"kind":16,"name":"ClanEnabledButCouldNotJoinAlreadyMember","url":"enums/platformerrorcodes.html#clanenabledbutcouldnotjoinalreadymember","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":340,"kind":16,"name":"ClanCannotJoinNoCredential","url":"enums/platformerrorcodes.html#clancannotjoinnocredential","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":341,"kind":16,"name":"NoClanMembershipForPlatform","url":"enums/platformerrorcodes.html#noclanmembershipforplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":342,"kind":16,"name":"GroupToGroupFollowLimitReached","url":"enums/platformerrorcodes.html#grouptogroupfollowlimitreached","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":343,"kind":16,"name":"ChildGroupAlreadyInAlliance","url":"enums/platformerrorcodes.html#childgroupalreadyinalliance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":344,"kind":16,"name":"OwnerGroupAlreadyInAlliance","url":"enums/platformerrorcodes.html#ownergroupalreadyinalliance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":345,"kind":16,"name":"AllianceOwnerCannotJoinAlliance","url":"enums/platformerrorcodes.html#allianceownercannotjoinalliance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":346,"kind":16,"name":"GroupNotInAlliance","url":"enums/platformerrorcodes.html#groupnotinalliance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":347,"kind":16,"name":"ChildGroupCannotInviteToAlliance","url":"enums/platformerrorcodes.html#childgroupcannotinvitetoalliance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":348,"kind":16,"name":"GroupToGroupAlreadyFollowed","url":"enums/platformerrorcodes.html#grouptogroupalreadyfollowed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":349,"kind":16,"name":"GroupToGroupNotFollowing","url":"enums/platformerrorcodes.html#grouptogroupnotfollowing","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":350,"kind":16,"name":"ClanMaximumMembershipReached","url":"enums/platformerrorcodes.html#clanmaximummembershipreached","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":351,"kind":16,"name":"ClanNameNotValid","url":"enums/platformerrorcodes.html#clannamenotvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":352,"kind":16,"name":"ClanNameNotValidError","url":"enums/platformerrorcodes.html#clannamenotvaliderror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":353,"kind":16,"name":"AllianceOwnerNotDefined","url":"enums/platformerrorcodes.html#allianceownernotdefined","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":354,"kind":16,"name":"AllianceChildNotDefined","url":"enums/platformerrorcodes.html#alliancechildnotdefined","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":355,"kind":16,"name":"ClanCultureIllegalCharacters","url":"enums/platformerrorcodes.html#clancultureillegalcharacters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":356,"kind":16,"name":"ClanTagIllegalCharacters","url":"enums/platformerrorcodes.html#clantagillegalcharacters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":357,"kind":16,"name":"ClanRequiresInvitation","url":"enums/platformerrorcodes.html#clanrequiresinvitation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":358,"kind":16,"name":"ClanMembershipClosed","url":"enums/platformerrorcodes.html#clanmembershipclosed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":359,"kind":16,"name":"ClanInviteAlreadyMember","url":"enums/platformerrorcodes.html#claninvitealreadymember","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":360,"kind":16,"name":"GroupInviteAlreadyMember","url":"enums/platformerrorcodes.html#groupinvitealreadymember","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":361,"kind":16,"name":"GroupJoinApprovalRequired","url":"enums/platformerrorcodes.html#groupjoinapprovalrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":362,"kind":16,"name":"ClanTagRequired","url":"enums/platformerrorcodes.html#clantagrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":363,"kind":16,"name":"GroupNameCannotStartOrEndWithWhiteSpace","url":"enums/platformerrorcodes.html#groupnamecannotstartorendwithwhitespace","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":364,"kind":16,"name":"ClanCallsignCannotStartOrEndWithWhiteSpace","url":"enums/platformerrorcodes.html#clancallsigncannotstartorendwithwhitespace","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":365,"kind":16,"name":"ClanMigrationFailed","url":"enums/platformerrorcodes.html#clanmigrationfailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":366,"kind":16,"name":"ClanNotEnabledAlreadyMemberOfAnotherClan","url":"enums/platformerrorcodes.html#clannotenabledalreadymemberofanotherclan","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":367,"kind":16,"name":"GroupModerationNotPermittedOnNonMembers","url":"enums/platformerrorcodes.html#groupmoderationnotpermittedonnonmembers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":368,"kind":16,"name":"ClanCreationInWorldServerFailed","url":"enums/platformerrorcodes.html#clancreationinworldserverfailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":369,"kind":16,"name":"ClanNotFound","url":"enums/platformerrorcodes.html#clannotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":370,"kind":16,"name":"ClanMembershipLevelDoesNotPermitThatAction","url":"enums/platformerrorcodes.html#clanmembershipleveldoesnotpermitthataction","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":371,"kind":16,"name":"ClanMemberNotFound","url":"enums/platformerrorcodes.html#clanmembernotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":372,"kind":16,"name":"ClanMissingMembershipApprovers","url":"enums/platformerrorcodes.html#clanmissingmembershipapprovers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":373,"kind":16,"name":"ClanInWrongStateForRequestedAction","url":"enums/platformerrorcodes.html#claninwrongstateforrequestedaction","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":374,"kind":16,"name":"ClanNameAlreadyUsed","url":"enums/platformerrorcodes.html#clannamealreadyused","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":375,"kind":16,"name":"ClanTooFewMembers","url":"enums/platformerrorcodes.html#clantoofewmembers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":376,"kind":16,"name":"ClanInfoCannotBeWhitespace","url":"enums/platformerrorcodes.html#claninfocannotbewhitespace","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":377,"kind":16,"name":"GroupCultureThrottle","url":"enums/platformerrorcodes.html#groupculturethrottle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":378,"kind":16,"name":"ClanTargetDisallowsInvites","url":"enums/platformerrorcodes.html#clantargetdisallowsinvites","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":379,"kind":16,"name":"ClanInvalidOperation","url":"enums/platformerrorcodes.html#claninvalidoperation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":380,"kind":16,"name":"ClanFounderCannotLeaveWithoutAbdication","url":"enums/platformerrorcodes.html#clanfoundercannotleavewithoutabdication","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":381,"kind":16,"name":"ClanNameReserved","url":"enums/platformerrorcodes.html#clannamereserved","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":382,"kind":16,"name":"ClanApplicantInClanSoNowInvited","url":"enums/platformerrorcodes.html#clanapplicantinclansonowinvited","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":383,"kind":16,"name":"ActivitiesUnknownException","url":"enums/platformerrorcodes.html#activitiesunknownexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":384,"kind":16,"name":"ActivitiesParameterNull","url":"enums/platformerrorcodes.html#activitiesparameternull","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":385,"kind":16,"name":"ActivityCountsDiabled","url":"enums/platformerrorcodes.html#activitycountsdiabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":386,"kind":16,"name":"ActivitySearchInvalidParameters","url":"enums/platformerrorcodes.html#activitysearchinvalidparameters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":387,"kind":16,"name":"ActivityPermissionDenied","url":"enums/platformerrorcodes.html#activitypermissiondenied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":388,"kind":16,"name":"ShareAlreadyShared","url":"enums/platformerrorcodes.html#sharealreadyshared","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":389,"kind":16,"name":"ActivityLoggingDisabled","url":"enums/platformerrorcodes.html#activityloggingdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":390,"kind":16,"name":"ClanRequiresExistingDestinyAccount","url":"enums/platformerrorcodes.html#clanrequiresexistingdestinyaccount","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":391,"kind":16,"name":"ItemAlreadyFollowed","url":"enums/platformerrorcodes.html#itemalreadyfollowed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":392,"kind":16,"name":"ItemNotFollowed","url":"enums/platformerrorcodes.html#itemnotfollowed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":393,"kind":16,"name":"CannotFollowSelf","url":"enums/platformerrorcodes.html#cannotfollowself","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":394,"kind":16,"name":"GroupFollowLimitExceeded","url":"enums/platformerrorcodes.html#groupfollowlimitexceeded","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":395,"kind":16,"name":"TagFollowLimitExceeded","url":"enums/platformerrorcodes.html#tagfollowlimitexceeded","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":396,"kind":16,"name":"UserFollowLimitExceeded","url":"enums/platformerrorcodes.html#userfollowlimitexceeded","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":397,"kind":16,"name":"FollowUnsupportedEntityType","url":"enums/platformerrorcodes.html#followunsupportedentitytype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":398,"kind":16,"name":"NoValidTagsInList","url":"enums/platformerrorcodes.html#novalidtagsinlist","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":399,"kind":16,"name":"BelowMinimumSuggestionLength","url":"enums/platformerrorcodes.html#belowminimumsuggestionlength","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":400,"kind":16,"name":"CannotGetSuggestionsOnMultipleTagsSimultaneously","url":"enums/platformerrorcodes.html#cannotgetsuggestionsonmultipletagssimultaneously","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":401,"kind":16,"name":"NotAValidPartialTag","url":"enums/platformerrorcodes.html#notavalidpartialtag","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":402,"kind":16,"name":"TagSuggestionsUnknownSqlResult","url":"enums/platformerrorcodes.html#tagsuggestionsunknownsqlresult","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":403,"kind":16,"name":"TagsUnableToLoadPopularTagsFromDatabase","url":"enums/platformerrorcodes.html#tagsunabletoloadpopulartagsfromdatabase","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":404,"kind":16,"name":"TagInvalid","url":"enums/platformerrorcodes.html#taginvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":405,"kind":16,"name":"TagNotFound","url":"enums/platformerrorcodes.html#tagnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":406,"kind":16,"name":"SingleTagExpected","url":"enums/platformerrorcodes.html#singletagexpected","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":407,"kind":16,"name":"TagsExceededMaximumPerItem","url":"enums/platformerrorcodes.html#tagsexceededmaximumperitem","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":408,"kind":16,"name":"IgnoreInvalidParameters","url":"enums/platformerrorcodes.html#ignoreinvalidparameters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":409,"kind":16,"name":"IgnoreSqlException","url":"enums/platformerrorcodes.html#ignoresqlexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":410,"kind":16,"name":"IgnoreErrorRetrievingGroupPermissions","url":"enums/platformerrorcodes.html#ignoreerrorretrievinggrouppermissions","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":411,"kind":16,"name":"IgnoreErrorInsufficientPermission","url":"enums/platformerrorcodes.html#ignoreerrorinsufficientpermission","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":412,"kind":16,"name":"IgnoreErrorRetrievingItem","url":"enums/platformerrorcodes.html#ignoreerrorretrievingitem","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":413,"kind":16,"name":"IgnoreCannotIgnoreSelf","url":"enums/platformerrorcodes.html#ignorecannotignoreself","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":414,"kind":16,"name":"IgnoreIllegalType","url":"enums/platformerrorcodes.html#ignoreillegaltype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":415,"kind":16,"name":"IgnoreNotFound","url":"enums/platformerrorcodes.html#ignorenotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":416,"kind":16,"name":"IgnoreUserGloballyIgnored","url":"enums/platformerrorcodes.html#ignoreusergloballyignored","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":417,"kind":16,"name":"IgnoreUserIgnored","url":"enums/platformerrorcodes.html#ignoreuserignored","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":418,"kind":16,"name":"NotificationSettingInvalid","url":"enums/platformerrorcodes.html#notificationsettinginvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":419,"kind":16,"name":"PsnApiExpiredAccessToken","url":"enums/platformerrorcodes.html#psnapiexpiredaccesstoken","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":420,"kind":16,"name":"PSNExForbidden","url":"enums/platformerrorcodes.html#psnexforbidden","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":421,"kind":16,"name":"PSNExSystemDisabled","url":"enums/platformerrorcodes.html#psnexsystemdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":422,"kind":16,"name":"PsnApiErrorCodeUnknown","url":"enums/platformerrorcodes.html#psnapierrorcodeunknown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":423,"kind":16,"name":"PsnApiErrorWebException","url":"enums/platformerrorcodes.html#psnapierrorwebexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":424,"kind":16,"name":"PsnApiBadRequest","url":"enums/platformerrorcodes.html#psnapibadrequest","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":425,"kind":16,"name":"PsnApiAccessTokenRequired","url":"enums/platformerrorcodes.html#psnapiaccesstokenrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":426,"kind":16,"name":"PsnApiInvalidAccessToken","url":"enums/platformerrorcodes.html#psnapiinvalidaccesstoken","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":427,"kind":16,"name":"PsnApiBannedUser","url":"enums/platformerrorcodes.html#psnapibanneduser","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":428,"kind":16,"name":"PsnApiAccountUpgradeRequired","url":"enums/platformerrorcodes.html#psnapiaccountupgraderequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":429,"kind":16,"name":"PsnApiServiceTemporarilyUnavailable","url":"enums/platformerrorcodes.html#psnapiservicetemporarilyunavailable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":430,"kind":16,"name":"PsnApiServerBusy","url":"enums/platformerrorcodes.html#psnapiserverbusy","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":431,"kind":16,"name":"PsnApiUnderMaintenance","url":"enums/platformerrorcodes.html#psnapiundermaintenance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":432,"kind":16,"name":"PsnApiProfileUserNotFound","url":"enums/platformerrorcodes.html#psnapiprofileusernotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":433,"kind":16,"name":"PsnApiProfilePrivacyRestriction","url":"enums/platformerrorcodes.html#psnapiprofileprivacyrestriction","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":434,"kind":16,"name":"PsnApiProfileUnderMaintenance","url":"enums/platformerrorcodes.html#psnapiprofileundermaintenance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":435,"kind":16,"name":"PsnApiAccountAttributeMissing","url":"enums/platformerrorcodes.html#psnapiaccountattributemissing","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":436,"kind":16,"name":"PsnApiNoPermission","url":"enums/platformerrorcodes.html#psnapinopermission","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":437,"kind":16,"name":"PsnApiTargetUserBlocked","url":"enums/platformerrorcodes.html#psnapitargetuserblocked","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":438,"kind":16,"name":"XblExSystemDisabled","url":"enums/platformerrorcodes.html#xblexsystemdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":439,"kind":16,"name":"XblExUnknownError","url":"enums/platformerrorcodes.html#xblexunknownerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":440,"kind":16,"name":"XblApiErrorWebException","url":"enums/platformerrorcodes.html#xblapierrorwebexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":441,"kind":16,"name":"XblStsTokenInvalid","url":"enums/platformerrorcodes.html#xblststokeninvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":442,"kind":16,"name":"XblStsMissingToken","url":"enums/platformerrorcodes.html#xblstsmissingtoken","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":443,"kind":16,"name":"XblStsExpiredToken","url":"enums/platformerrorcodes.html#xblstsexpiredtoken","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":444,"kind":16,"name":"XblAccessToTheSandboxDenied","url":"enums/platformerrorcodes.html#xblaccesstothesandboxdenied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":445,"kind":16,"name":"XblMsaResponseMissing","url":"enums/platformerrorcodes.html#xblmsaresponsemissing","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":446,"kind":16,"name":"XblMsaAccessTokenExpired","url":"enums/platformerrorcodes.html#xblmsaaccesstokenexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":447,"kind":16,"name":"XblMsaInvalidRequest","url":"enums/platformerrorcodes.html#xblmsainvalidrequest","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":448,"kind":16,"name":"XblMsaFriendsRequireSignIn","url":"enums/platformerrorcodes.html#xblmsafriendsrequiresignin","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":449,"kind":16,"name":"XblUserActionRequired","url":"enums/platformerrorcodes.html#xbluseractionrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":450,"kind":16,"name":"XblParentalControls","url":"enums/platformerrorcodes.html#xblparentalcontrols","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":451,"kind":16,"name":"XblDeveloperAccount","url":"enums/platformerrorcodes.html#xbldeveloperaccount","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":452,"kind":16,"name":"XblUserTokenExpired","url":"enums/platformerrorcodes.html#xblusertokenexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":453,"kind":16,"name":"XblUserTokenInvalid","url":"enums/platformerrorcodes.html#xblusertokeninvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":454,"kind":16,"name":"XblOffline","url":"enums/platformerrorcodes.html#xbloffline","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":455,"kind":16,"name":"XblUnknownErrorCode","url":"enums/platformerrorcodes.html#xblunknownerrorcode","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":456,"kind":16,"name":"XblMsaInvalidGrant","url":"enums/platformerrorcodes.html#xblmsainvalidgrant","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":457,"kind":16,"name":"ReportNotYetResolved","url":"enums/platformerrorcodes.html#reportnotyetresolved","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":458,"kind":16,"name":"ReportOverturnDoesNotChangeDecision","url":"enums/platformerrorcodes.html#reportoverturndoesnotchangedecision","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":459,"kind":16,"name":"ReportNotFound","url":"enums/platformerrorcodes.html#reportnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":460,"kind":16,"name":"ReportAlreadyReported","url":"enums/platformerrorcodes.html#reportalreadyreported","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":461,"kind":16,"name":"ReportInvalidResolution","url":"enums/platformerrorcodes.html#reportinvalidresolution","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":462,"kind":16,"name":"ReportNotAssignedToYou","url":"enums/platformerrorcodes.html#reportnotassignedtoyou","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":463,"kind":16,"name":"LegacyGameStatsSystemDisabled","url":"enums/platformerrorcodes.html#legacygamestatssystemdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":464,"kind":16,"name":"LegacyGameStatsUnknownError","url":"enums/platformerrorcodes.html#legacygamestatsunknownerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":465,"kind":16,"name":"LegacyGameStatsMalformedSneakerNetCode","url":"enums/platformerrorcodes.html#legacygamestatsmalformedsneakernetcode","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":466,"kind":16,"name":"DestinyAccountAcquisitionFailure","url":"enums/platformerrorcodes.html#destinyaccountacquisitionfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":467,"kind":16,"name":"DestinyAccountNotFound","url":"enums/platformerrorcodes.html#destinyaccountnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":468,"kind":16,"name":"DestinyBuildStatsDatabaseError","url":"enums/platformerrorcodes.html#destinybuildstatsdatabaseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":469,"kind":16,"name":"DestinyCharacterStatsDatabaseError","url":"enums/platformerrorcodes.html#destinycharacterstatsdatabaseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":470,"kind":16,"name":"DestinyPvPStatsDatabaseError","url":"enums/platformerrorcodes.html#destinypvpstatsdatabaseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":471,"kind":16,"name":"DestinyPvEStatsDatabaseError","url":"enums/platformerrorcodes.html#destinypvestatsdatabaseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":472,"kind":16,"name":"DestinyGrimoireStatsDatabaseError","url":"enums/platformerrorcodes.html#destinygrimoirestatsdatabaseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":473,"kind":16,"name":"DestinyStatsParameterMembershipTypeParseError","url":"enums/platformerrorcodes.html#destinystatsparametermembershiptypeparseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":474,"kind":16,"name":"DestinyStatsParameterMembershipIdParseError","url":"enums/platformerrorcodes.html#destinystatsparametermembershipidparseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":475,"kind":16,"name":"DestinyStatsParameterRangeParseError","url":"enums/platformerrorcodes.html#destinystatsparameterrangeparseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":476,"kind":16,"name":"DestinyStringItemHashNotFound","url":"enums/platformerrorcodes.html#destinystringitemhashnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":477,"kind":16,"name":"DestinyStringSetNotFound","url":"enums/platformerrorcodes.html#destinystringsetnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":478,"kind":16,"name":"DestinyContentLookupNotFoundForKey","url":"enums/platformerrorcodes.html#destinycontentlookupnotfoundforkey","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":479,"kind":16,"name":"DestinyContentItemNotFound","url":"enums/platformerrorcodes.html#destinycontentitemnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":480,"kind":16,"name":"DestinyContentSectionNotFound","url":"enums/platformerrorcodes.html#destinycontentsectionnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":481,"kind":16,"name":"DestinyContentPropertyNotFound","url":"enums/platformerrorcodes.html#destinycontentpropertynotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":482,"kind":16,"name":"DestinyContentConfigNotFound","url":"enums/platformerrorcodes.html#destinycontentconfignotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":483,"kind":16,"name":"DestinyContentPropertyBucketValueNotFound","url":"enums/platformerrorcodes.html#destinycontentpropertybucketvaluenotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":484,"kind":16,"name":"DestinyUnexpectedError","url":"enums/platformerrorcodes.html#destinyunexpectederror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":485,"kind":16,"name":"DestinyInvalidAction","url":"enums/platformerrorcodes.html#destinyinvalidaction","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":486,"kind":16,"name":"DestinyCharacterNotFound","url":"enums/platformerrorcodes.html#destinycharacternotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":487,"kind":16,"name":"DestinyInvalidFlag","url":"enums/platformerrorcodes.html#destinyinvalidflag","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":488,"kind":16,"name":"DestinyInvalidRequest","url":"enums/platformerrorcodes.html#destinyinvalidrequest","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":489,"kind":16,"name":"DestinyItemNotFound","url":"enums/platformerrorcodes.html#destinyitemnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":490,"kind":16,"name":"DestinyInvalidCustomizationChoices","url":"enums/platformerrorcodes.html#destinyinvalidcustomizationchoices","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":491,"kind":16,"name":"DestinyVendorItemNotFound","url":"enums/platformerrorcodes.html#destinyvendoritemnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":492,"kind":16,"name":"DestinyInternalError","url":"enums/platformerrorcodes.html#destinyinternalerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":493,"kind":16,"name":"DestinyVendorNotFound","url":"enums/platformerrorcodes.html#destinyvendornotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":494,"kind":16,"name":"DestinyRecentActivitiesDatabaseError","url":"enums/platformerrorcodes.html#destinyrecentactivitiesdatabaseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":495,"kind":16,"name":"DestinyItemBucketNotFound","url":"enums/platformerrorcodes.html#destinyitembucketnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":496,"kind":16,"name":"DestinyInvalidMembershipType","url":"enums/platformerrorcodes.html#destinyinvalidmembershiptype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":497,"kind":16,"name":"DestinyVersionIncompatibility","url":"enums/platformerrorcodes.html#destinyversionincompatibility","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":498,"kind":16,"name":"DestinyItemAlreadyInInventory","url":"enums/platformerrorcodes.html#destinyitemalreadyininventory","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":499,"kind":16,"name":"DestinyBucketNotFound","url":"enums/platformerrorcodes.html#destinybucketnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":500,"kind":16,"name":"DestinyCharacterNotInTower","url":"enums/platformerrorcodes.html#destinycharacternotintower","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":501,"kind":16,"name":"DestinyCharacterNotLoggedIn","url":"enums/platformerrorcodes.html#destinycharacternotloggedin","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":502,"kind":16,"name":"DestinyDefinitionsNotLoaded","url":"enums/platformerrorcodes.html#destinydefinitionsnotloaded","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":503,"kind":16,"name":"DestinyInventoryFull","url":"enums/platformerrorcodes.html#destinyinventoryfull","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":504,"kind":16,"name":"DestinyItemFailedLevelCheck","url":"enums/platformerrorcodes.html#destinyitemfailedlevelcheck","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":505,"kind":16,"name":"DestinyItemFailedUnlockCheck","url":"enums/platformerrorcodes.html#destinyitemfailedunlockcheck","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":506,"kind":16,"name":"DestinyItemUnequippable","url":"enums/platformerrorcodes.html#destinyitemunequippable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":507,"kind":16,"name":"DestinyItemUniqueEquipRestricted","url":"enums/platformerrorcodes.html#destinyitemuniqueequiprestricted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":508,"kind":16,"name":"DestinyNoRoomInDestination","url":"enums/platformerrorcodes.html#destinynoroomindestination","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":509,"kind":16,"name":"DestinyServiceFailure","url":"enums/platformerrorcodes.html#destinyservicefailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":510,"kind":16,"name":"DestinyServiceRetired","url":"enums/platformerrorcodes.html#destinyserviceretired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":511,"kind":16,"name":"DestinyTransferFailed","url":"enums/platformerrorcodes.html#destinytransferfailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":512,"kind":16,"name":"DestinyTransferNotFoundForSourceBucket","url":"enums/platformerrorcodes.html#destinytransfernotfoundforsourcebucket","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":513,"kind":16,"name":"DestinyUnexpectedResultInVendorTransferCheck","url":"enums/platformerrorcodes.html#destinyunexpectedresultinvendortransfercheck","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":514,"kind":16,"name":"DestinyUniquenessViolation","url":"enums/platformerrorcodes.html#destinyuniquenessviolation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":515,"kind":16,"name":"DestinyErrorDeserializationFailure","url":"enums/platformerrorcodes.html#destinyerrordeserializationfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":516,"kind":16,"name":"DestinyValidAccountTicketRequired","url":"enums/platformerrorcodes.html#destinyvalidaccountticketrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":517,"kind":16,"name":"DestinyShardRelayClientTimeout","url":"enums/platformerrorcodes.html#destinyshardrelayclienttimeout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":518,"kind":16,"name":"DestinyShardRelayProxyTimeout","url":"enums/platformerrorcodes.html#destinyshardrelayproxytimeout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":519,"kind":16,"name":"DestinyPGCRNotFound","url":"enums/platformerrorcodes.html#destinypgcrnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":520,"kind":16,"name":"DestinyAccountMustBeOffline","url":"enums/platformerrorcodes.html#destinyaccountmustbeoffline","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":521,"kind":16,"name":"DestinyCanOnlyEquipInGame","url":"enums/platformerrorcodes.html#destinycanonlyequipingame","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":522,"kind":16,"name":"DestinyCannotPerformActionOnEquippedItem","url":"enums/platformerrorcodes.html#destinycannotperformactiononequippeditem","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":523,"kind":16,"name":"DestinyQuestAlreadyCompleted","url":"enums/platformerrorcodes.html#destinyquestalreadycompleted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":524,"kind":16,"name":"DestinyQuestAlreadyTracked","url":"enums/platformerrorcodes.html#destinyquestalreadytracked","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":525,"kind":16,"name":"DestinyTrackableQuestsFull","url":"enums/platformerrorcodes.html#destinytrackablequestsfull","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":526,"kind":16,"name":"DestinyItemNotTransferrable","url":"enums/platformerrorcodes.html#destinyitemnottransferrable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":527,"kind":16,"name":"DestinyVendorPurchaseNotAllowed","url":"enums/platformerrorcodes.html#destinyvendorpurchasenotallowed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":528,"kind":16,"name":"DestinyContentVersionMismatch","url":"enums/platformerrorcodes.html#destinycontentversionmismatch","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":529,"kind":16,"name":"DestinyItemActionForbidden","url":"enums/platformerrorcodes.html#destinyitemactionforbidden","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":530,"kind":16,"name":"DestinyRefundInvalid","url":"enums/platformerrorcodes.html#destinyrefundinvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":531,"kind":16,"name":"DestinyPrivacyRestriction","url":"enums/platformerrorcodes.html#destinyprivacyrestriction","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":532,"kind":16,"name":"DestinyActionInsufficientPrivileges","url":"enums/platformerrorcodes.html#destinyactioninsufficientprivileges","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":533,"kind":16,"name":"DestinyInvalidClaimException","url":"enums/platformerrorcodes.html#destinyinvalidclaimexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":534,"kind":16,"name":"DestinyLegacyPlatformRestricted","url":"enums/platformerrorcodes.html#destinylegacyplatformrestricted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":535,"kind":16,"name":"DestinyLegacyPlatformInUse","url":"enums/platformerrorcodes.html#destinylegacyplatforminuse","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":536,"kind":16,"name":"DestinyLegacyPlatformInaccessible","url":"enums/platformerrorcodes.html#destinylegacyplatforminaccessible","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":537,"kind":16,"name":"DestinyCannotPerformActionAtThisLocation","url":"enums/platformerrorcodes.html#destinycannotperformactionatthislocation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":538,"kind":16,"name":"DestinyThrottledByGameServer","url":"enums/platformerrorcodes.html#destinythrottledbygameserver","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":539,"kind":16,"name":"DestinyItemNotTransferrableHasSideEffects","url":"enums/platformerrorcodes.html#destinyitemnottransferrablehassideeffects","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":540,"kind":16,"name":"DestinyItemLocked","url":"enums/platformerrorcodes.html#destinyitemlocked","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":541,"kind":16,"name":"DestinyCannotAffordMaterialRequirements","url":"enums/platformerrorcodes.html#destinycannotaffordmaterialrequirements","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":542,"kind":16,"name":"DestinyFailedPlugInsertionRules","url":"enums/platformerrorcodes.html#destinyfailedpluginsertionrules","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":543,"kind":16,"name":"DestinySocketNotFound","url":"enums/platformerrorcodes.html#destinysocketnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":544,"kind":16,"name":"DestinySocketActionNotAllowed","url":"enums/platformerrorcodes.html#destinysocketactionnotallowed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":545,"kind":16,"name":"DestinySocketAlreadyHasPlug","url":"enums/platformerrorcodes.html#destinysocketalreadyhasplug","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":546,"kind":16,"name":"DestinyPlugItemNotAvailable","url":"enums/platformerrorcodes.html#destinyplugitemnotavailable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":547,"kind":16,"name":"DestinyCharacterLoggedInNotAllowed","url":"enums/platformerrorcodes.html#destinycharacterloggedinnotallowed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":548,"kind":16,"name":"DestinyPublicAccountNotAccessible","url":"enums/platformerrorcodes.html#destinypublicaccountnotaccessible","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":549,"kind":16,"name":"FbInvalidRequest","url":"enums/platformerrorcodes.html#fbinvalidrequest","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":550,"kind":16,"name":"FbRedirectMismatch","url":"enums/platformerrorcodes.html#fbredirectmismatch","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":551,"kind":16,"name":"FbAccessDenied","url":"enums/platformerrorcodes.html#fbaccessdenied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":552,"kind":16,"name":"FbUnsupportedResponseType","url":"enums/platformerrorcodes.html#fbunsupportedresponsetype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":553,"kind":16,"name":"FbInvalidScope","url":"enums/platformerrorcodes.html#fbinvalidscope","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":554,"kind":16,"name":"FbUnsupportedGrantType","url":"enums/platformerrorcodes.html#fbunsupportedgranttype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":555,"kind":16,"name":"FbInvalidGrant","url":"enums/platformerrorcodes.html#fbinvalidgrant","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":556,"kind":16,"name":"InvitationExpired","url":"enums/platformerrorcodes.html#invitationexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":557,"kind":16,"name":"InvitationUnknownType","url":"enums/platformerrorcodes.html#invitationunknowntype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":558,"kind":16,"name":"InvitationInvalidResponseStatus","url":"enums/platformerrorcodes.html#invitationinvalidresponsestatus","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":559,"kind":16,"name":"InvitationInvalidType","url":"enums/platformerrorcodes.html#invitationinvalidtype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":560,"kind":16,"name":"InvitationAlreadyPending","url":"enums/platformerrorcodes.html#invitationalreadypending","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":561,"kind":16,"name":"InvitationInsufficientPermission","url":"enums/platformerrorcodes.html#invitationinsufficientpermission","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":562,"kind":16,"name":"InvitationInvalidCode","url":"enums/platformerrorcodes.html#invitationinvalidcode","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":563,"kind":16,"name":"InvitationInvalidTargetState","url":"enums/platformerrorcodes.html#invitationinvalidtargetstate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":564,"kind":16,"name":"InvitationCannotBeReactivated","url":"enums/platformerrorcodes.html#invitationcannotbereactivated","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":565,"kind":16,"name":"InvitationNoRecipients","url":"enums/platformerrorcodes.html#invitationnorecipients","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":566,"kind":16,"name":"InvitationGroupCannotSendToSelf","url":"enums/platformerrorcodes.html#invitationgroupcannotsendtoself","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":567,"kind":16,"name":"InvitationTooManyRecipients","url":"enums/platformerrorcodes.html#invitationtoomanyrecipients","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":568,"kind":16,"name":"InvitationInvalid","url":"enums/platformerrorcodes.html#invitationinvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":569,"kind":16,"name":"InvitationNotFound","url":"enums/platformerrorcodes.html#invitationnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":570,"kind":16,"name":"TokenInvalid","url":"enums/platformerrorcodes.html#tokeninvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":571,"kind":16,"name":"TokenBadFormat","url":"enums/platformerrorcodes.html#tokenbadformat","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":572,"kind":16,"name":"TokenAlreadyClaimed","url":"enums/platformerrorcodes.html#tokenalreadyclaimed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":573,"kind":16,"name":"TokenAlreadyClaimedSelf","url":"enums/platformerrorcodes.html#tokenalreadyclaimedself","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":574,"kind":16,"name":"TokenThrottling","url":"enums/platformerrorcodes.html#tokenthrottling","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":575,"kind":16,"name":"TokenUnknownRedemptionFailure","url":"enums/platformerrorcodes.html#tokenunknownredemptionfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":576,"kind":16,"name":"TokenPurchaseClaimFailedAfterTokenClaimed","url":"enums/platformerrorcodes.html#tokenpurchaseclaimfailedaftertokenclaimed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":577,"kind":16,"name":"TokenUserAlreadyOwnsOffer","url":"enums/platformerrorcodes.html#tokenuseralreadyownsoffer","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":578,"kind":16,"name":"TokenInvalidOfferKey","url":"enums/platformerrorcodes.html#tokeninvalidofferkey","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":579,"kind":16,"name":"TokenEmailNotValidated","url":"enums/platformerrorcodes.html#tokenemailnotvalidated","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":580,"kind":16,"name":"TokenProvisioningBadVendorOrOffer","url":"enums/platformerrorcodes.html#tokenprovisioningbadvendororoffer","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":581,"kind":16,"name":"TokenPurchaseHistoryUnknownError","url":"enums/platformerrorcodes.html#tokenpurchasehistoryunknownerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":582,"kind":16,"name":"TokenThrottleStateUnknownError","url":"enums/platformerrorcodes.html#tokenthrottlestateunknownerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":583,"kind":16,"name":"TokenUserAgeNotVerified","url":"enums/platformerrorcodes.html#tokenuseragenotverified","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":584,"kind":16,"name":"TokenExceededOfferMaximum","url":"enums/platformerrorcodes.html#tokenexceededoffermaximum","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":585,"kind":16,"name":"TokenNoAvailableUnlocks","url":"enums/platformerrorcodes.html#tokennoavailableunlocks","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":586,"kind":16,"name":"TokenMarketplaceInvalidPlatform","url":"enums/platformerrorcodes.html#tokenmarketplaceinvalidplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":587,"kind":16,"name":"TokenNoMarketplaceCodesFound","url":"enums/platformerrorcodes.html#tokennomarketplacecodesfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":588,"kind":16,"name":"TokenOfferNotAvailableForRedemption","url":"enums/platformerrorcodes.html#tokenoffernotavailableforredemption","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":589,"kind":16,"name":"TokenUnlockPartialFailure","url":"enums/platformerrorcodes.html#tokenunlockpartialfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":590,"kind":16,"name":"TokenMarketplaceInvalidRegion","url":"enums/platformerrorcodes.html#tokenmarketplaceinvalidregion","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":591,"kind":16,"name":"TokenOfferExpired","url":"enums/platformerrorcodes.html#tokenofferexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":592,"kind":16,"name":"RAFExceededMaximumReferrals","url":"enums/platformerrorcodes.html#rafexceededmaximumreferrals","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":593,"kind":16,"name":"RAFDuplicateBond","url":"enums/platformerrorcodes.html#rafduplicatebond","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":594,"kind":16,"name":"RAFNoValidVeteranDestinyMembershipsFound","url":"enums/platformerrorcodes.html#rafnovalidveterandestinymembershipsfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":595,"kind":16,"name":"RAFNotAValidVeteranUser","url":"enums/platformerrorcodes.html#rafnotavalidveteranuser","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":596,"kind":16,"name":"RAFCodeAlreadyClaimedOrNotFound","url":"enums/platformerrorcodes.html#rafcodealreadyclaimedornotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":597,"kind":16,"name":"RAFMismatchedDestinyMembershipType","url":"enums/platformerrorcodes.html#rafmismatcheddestinymembershiptype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":598,"kind":16,"name":"RAFUnableToAccessPurchaseHistory","url":"enums/platformerrorcodes.html#rafunabletoaccesspurchasehistory","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":599,"kind":16,"name":"RAFUnableToCreateBond","url":"enums/platformerrorcodes.html#rafunabletocreatebond","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":600,"kind":16,"name":"RAFUnableToFindBond","url":"enums/platformerrorcodes.html#rafunabletofindbond","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":601,"kind":16,"name":"RAFUnableToRemoveBond","url":"enums/platformerrorcodes.html#rafunabletoremovebond","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":602,"kind":16,"name":"RAFCannotBondToSelf","url":"enums/platformerrorcodes.html#rafcannotbondtoself","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":603,"kind":16,"name":"RAFInvalidPlatform","url":"enums/platformerrorcodes.html#rafinvalidplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":604,"kind":16,"name":"RAFGenerateThrottled","url":"enums/platformerrorcodes.html#rafgeneratethrottled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":605,"kind":16,"name":"RAFUnableToCreateBondVersionMismatch","url":"enums/platformerrorcodes.html#rafunabletocreatebondversionmismatch","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":606,"kind":16,"name":"RAFUnableToRemoveBondVersionMismatch","url":"enums/platformerrorcodes.html#rafunabletoremovebondversionmismatch","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":607,"kind":16,"name":"RAFRedeemThrottled","url":"enums/platformerrorcodes.html#rafredeemthrottled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":608,"kind":16,"name":"NoAvailableDiscountCode","url":"enums/platformerrorcodes.html#noavailablediscountcode","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":609,"kind":16,"name":"DiscountAlreadyClaimed","url":"enums/platformerrorcodes.html#discountalreadyclaimed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":610,"kind":16,"name":"DiscountClaimFailure","url":"enums/platformerrorcodes.html#discountclaimfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":611,"kind":16,"name":"DiscountConfigurationFailure","url":"enums/platformerrorcodes.html#discountconfigurationfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":612,"kind":16,"name":"DiscountGenerationFailure","url":"enums/platformerrorcodes.html#discountgenerationfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":613,"kind":16,"name":"DiscountAlreadyExists","url":"enums/platformerrorcodes.html#discountalreadyexists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":614,"kind":16,"name":"TokenRequiresCredentialXuid","url":"enums/platformerrorcodes.html#tokenrequirescredentialxuid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":615,"kind":16,"name":"TokenRequiresCredentialPsnid","url":"enums/platformerrorcodes.html#tokenrequirescredentialpsnid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":616,"kind":16,"name":"OfferRequired","url":"enums/platformerrorcodes.html#offerrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":617,"kind":16,"name":"UnknownEververseHistoryError","url":"enums/platformerrorcodes.html#unknowneverversehistoryerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":618,"kind":16,"name":"MissingEververseHistoryError","url":"enums/platformerrorcodes.html#missingeverversehistoryerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":619,"kind":16,"name":"BungieRewardEmailStateInvalid","url":"enums/platformerrorcodes.html#bungierewardemailstateinvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":620,"kind":16,"name":"BungieRewardNotYetClaimable","url":"enums/platformerrorcodes.html#bungierewardnotyetclaimable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":621,"kind":16,"name":"MissingOfferConfig","url":"enums/platformerrorcodes.html#missingofferconfig","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":622,"kind":16,"name":"RAFQuestEntitlementRequiresBnet","url":"enums/platformerrorcodes.html#rafquestentitlementrequiresbnet","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":623,"kind":16,"name":"RAFQuestEntitlementTransportFailure","url":"enums/platformerrorcodes.html#rafquestentitlementtransportfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":624,"kind":16,"name":"RAFQuestEntitlementUnknownFailure","url":"enums/platformerrorcodes.html#rafquestentitlementunknownfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":625,"kind":16,"name":"RAFVeteranRewardUnknownFailure","url":"enums/platformerrorcodes.html#rafveteranrewardunknownfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":626,"kind":16,"name":"RAFTooEarlyToCancelBond","url":"enums/platformerrorcodes.html#raftooearlytocancelbond","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":627,"kind":16,"name":"ApiExceededMaxKeys","url":"enums/platformerrorcodes.html#apiexceededmaxkeys","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":628,"kind":16,"name":"ApiInvalidOrExpiredKey","url":"enums/platformerrorcodes.html#apiinvalidorexpiredkey","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":629,"kind":16,"name":"ApiKeyMissingFromRequest","url":"enums/platformerrorcodes.html#apikeymissingfromrequest","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":630,"kind":16,"name":"ApplicationDisabled","url":"enums/platformerrorcodes.html#applicationdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":631,"kind":16,"name":"ApplicationExceededMax","url":"enums/platformerrorcodes.html#applicationexceededmax","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":632,"kind":16,"name":"ApplicationDisallowedByScope","url":"enums/platformerrorcodes.html#applicationdisallowedbyscope","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":633,"kind":16,"name":"AuthorizationCodeInvalid","url":"enums/platformerrorcodes.html#authorizationcodeinvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":634,"kind":16,"name":"OriginHeaderDoesNotMatchKey","url":"enums/platformerrorcodes.html#originheaderdoesnotmatchkey","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":635,"kind":16,"name":"AccessNotPermittedByApplicationScope","url":"enums/platformerrorcodes.html#accessnotpermittedbyapplicationscope","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":636,"kind":16,"name":"ApplicationNameIsTaken","url":"enums/platformerrorcodes.html#applicationnameistaken","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":637,"kind":16,"name":"RefreshTokenNotYetValid","url":"enums/platformerrorcodes.html#refreshtokennotyetvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":638,"kind":16,"name":"AccessTokenHasExpired","url":"enums/platformerrorcodes.html#accesstokenhasexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":639,"kind":16,"name":"ApplicationTokenFormatNotValid","url":"enums/platformerrorcodes.html#applicationtokenformatnotvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":640,"kind":16,"name":"ApplicationNotConfiguredForBungieAuth","url":"enums/platformerrorcodes.html#applicationnotconfiguredforbungieauth","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":641,"kind":16,"name":"ApplicationNotConfiguredForOAuth","url":"enums/platformerrorcodes.html#applicationnotconfiguredforoauth","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":642,"kind":16,"name":"OAuthAccessTokenExpired","url":"enums/platformerrorcodes.html#oauthaccesstokenexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":643,"kind":16,"name":"PartnershipInvalidType","url":"enums/platformerrorcodes.html#partnershipinvalidtype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":644,"kind":16,"name":"PartnershipValidationError","url":"enums/platformerrorcodes.html#partnershipvalidationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":645,"kind":16,"name":"PartnershipValidationTimeout","url":"enums/platformerrorcodes.html#partnershipvalidationtimeout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":646,"kind":16,"name":"PartnershipAccessFailure","url":"enums/platformerrorcodes.html#partnershipaccessfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":647,"kind":16,"name":"PartnershipAccountInvalid","url":"enums/platformerrorcodes.html#partnershipaccountinvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":648,"kind":16,"name":"PartnershipGetAccountInfoFailure","url":"enums/platformerrorcodes.html#partnershipgetaccountinfofailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":649,"kind":16,"name":"PartnershipDisabled","url":"enums/platformerrorcodes.html#partnershipdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":650,"kind":16,"name":"PartnershipAlreadyExists","url":"enums/platformerrorcodes.html#partnershipalreadyexists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":651,"kind":16,"name":"CommunityStreamingUnavailable","url":"enums/platformerrorcodes.html#communitystreamingunavailable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":652,"kind":16,"name":"TwitchNotLinked","url":"enums/platformerrorcodes.html#twitchnotlinked","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":653,"kind":16,"name":"TwitchAccountNotFound","url":"enums/platformerrorcodes.html#twitchaccountnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":654,"kind":16,"name":"TwitchCouldNotLoadDestinyInfo","url":"enums/platformerrorcodes.html#twitchcouldnotloaddestinyinfo","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":655,"kind":16,"name":"TrendingCategoryNotFound","url":"enums/platformerrorcodes.html#trendingcategorynotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":656,"kind":16,"name":"TrendingEntryTypeNotSupported","url":"enums/platformerrorcodes.html#trendingentrytypenotsupported","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":657,"kind":16,"name":"ReportOffenderNotInPgcr","url":"enums/platformerrorcodes.html#reportoffendernotinpgcr","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":658,"kind":16,"name":"ReportRequestorNotInPgcr","url":"enums/platformerrorcodes.html#reportrequestornotinpgcr","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":659,"kind":16,"name":"ReportSubmissionFailed","url":"enums/platformerrorcodes.html#reportsubmissionfailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":660,"kind":16,"name":"ReportCannotReportSelf","url":"enums/platformerrorcodes.html#reportcannotreportself","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":661,"kind":16,"name":"AwaTypeDisabled","url":"enums/platformerrorcodes.html#awatypedisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":662,"kind":16,"name":"AwaTooManyPendingRequests","url":"enums/platformerrorcodes.html#awatoomanypendingrequests","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":663,"kind":16,"name":"AwaTheFeatureRequiresARegisteredDevice","url":"enums/platformerrorcodes.html#awathefeaturerequiresaregistereddevice","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":664,"kind":16,"name":"AwaRequestWasUnansweredForTooLong","url":"enums/platformerrorcodes.html#awarequestwasunansweredfortoolong","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":665,"kind":16,"name":"AwaWriteRequestMissingOrInvalidToken","url":"enums/platformerrorcodes.html#awawriterequestmissingorinvalidtoken","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":666,"kind":16,"name":"AwaWriteRequestTokenExpired","url":"enums/platformerrorcodes.html#awawriterequesttokenexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":667,"kind":16,"name":"AwaWriteRequestTokenUsageLimitReached","url":"enums/platformerrorcodes.html#awawriterequesttokenusagelimitreached","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":668,"kind":16,"name":"ClanFireteamNotFound","url":"enums/platformerrorcodes.html#clanfireteamnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":669,"kind":16,"name":"ClanFireteamAddNoAlternatesForImmediate","url":"enums/platformerrorcodes.html#clanfireteamaddnoalternatesforimmediate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":670,"kind":16,"name":"ClanFireteamFull","url":"enums/platformerrorcodes.html#clanfireteamfull","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":671,"kind":16,"name":"ClanFireteamAltFull","url":"enums/platformerrorcodes.html#clanfireteamaltfull","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":672,"kind":16,"name":"ClanFireteamBlocked","url":"enums/platformerrorcodes.html#clanfireteamblocked","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":673,"kind":16,"name":"ClanFireteamPlayerEntryNotFound","url":"enums/platformerrorcodes.html#clanfireteamplayerentrynotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":674,"kind":16,"name":"ClanFireteamPermissions","url":"enums/platformerrorcodes.html#clanfireteampermissions","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":675,"kind":16,"name":"ClanFireteamInvalidPlatform","url":"enums/platformerrorcodes.html#clanfireteaminvalidplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":676,"kind":16,"name":"ClanFireteamCannotAdjustSlotCount","url":"enums/platformerrorcodes.html#clanfireteamcannotadjustslotcount","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":677,"kind":16,"name":"ClanFireteamInvalidPlayerPlatform","url":"enums/platformerrorcodes.html#clanfireteaminvalidplayerplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":678,"kind":16,"name":"ClanFireteamNotReadyForInvitesNotEnoughPlayers","url":"enums/platformerrorcodes.html#clanfireteamnotreadyforinvitesnotenoughplayers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":679,"kind":16,"name":"ClanFireteamGameInvitesNotSupportForPlatform","url":"enums/platformerrorcodes.html#clanfireteamgameinvitesnotsupportforplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":680,"kind":16,"name":"ClanFireteamPlatformInvitePreqFailure","url":"enums/platformerrorcodes.html#clanfireteamplatforminvitepreqfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":681,"kind":16,"name":"ClanFireteamInvalidAuthContext","url":"enums/platformerrorcodes.html#clanfireteaminvalidauthcontext","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":682,"kind":16,"name":"ClanFireteamInvalidAuthProviderPsn","url":"enums/platformerrorcodes.html#clanfireteaminvalidauthproviderpsn","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":683,"kind":16,"name":"ClanFireteamPs4SessionFull","url":"enums/platformerrorcodes.html#clanfireteamps4sessionfull","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":684,"kind":16,"name":"ClanFireteamInvalidAuthToken","url":"enums/platformerrorcodes.html#clanfireteaminvalidauthtoken","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":685,"kind":16,"name":"ClanFireteamScheduledFireteamsDisabled","url":"enums/platformerrorcodes.html#clanfireteamscheduledfireteamsdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":686,"kind":16,"name":"ClanFireteamNotReadyForInvitesNotScheduledYet","url":"enums/platformerrorcodes.html#clanfireteamnotreadyforinvitesnotscheduledyet","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":687,"kind":16,"name":"ClanFireteamNotReadyForInvitesClosed","url":"enums/platformerrorcodes.html#clanfireteamnotreadyforinvitesclosed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":688,"kind":16,"name":"ClanFireteamScheduledFireteamsRequireAdminPermissions","url":"enums/platformerrorcodes.html#clanfireteamscheduledfireteamsrequireadminpermissions","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":689,"kind":16,"name":"ClanFireteamNonPublicMustHaveClan","url":"enums/platformerrorcodes.html#clanfireteamnonpublicmusthaveclan","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":690,"kind":16,"name":"ClanFireteamPublicCreationRestriction","url":"enums/platformerrorcodes.html#clanfireteampubliccreationrestriction","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":691,"kind":16,"name":"ClanFireteamAlreadyJoined","url":"enums/platformerrorcodes.html#clanfireteamalreadyjoined","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":692,"kind":16,"name":"ClanFireteamScheduledFireteamsRange","url":"enums/platformerrorcodes.html#clanfireteamscheduledfireteamsrange","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":693,"kind":16,"name":"ClanFireteamPublicCreationRestrictionExtended","url":"enums/platformerrorcodes.html#clanfireteampubliccreationrestrictionextended","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":694,"kind":4,"name":"BungieMembershipType","url":"enums/bungiemembershiptype.html","classes":"tsd-kind-enum"},{"id":695,"kind":16,"name":"None","url":"enums/bungiemembershiptype.html#none","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BungieMembershipType"},{"id":696,"kind":16,"name":"TigerXbox","url":"enums/bungiemembershiptype.html#tigerxbox","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BungieMembershipType"},{"id":697,"kind":16,"name":"TigerPsn","url":"enums/bungiemembershiptype.html#tigerpsn","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BungieMembershipType"},{"id":698,"kind":16,"name":"TigerBlizzard","url":"enums/bungiemembershiptype.html#tigerblizzard","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BungieMembershipType"},{"id":699,"kind":16,"name":"TigerDemon","url":"enums/bungiemembershiptype.html#tigerdemon","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BungieMembershipType"},{"id":700,"kind":16,"name":"BungieNext","url":"enums/bungiemembershiptype.html#bungienext","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BungieMembershipType"},{"id":701,"kind":16,"name":"All","url":"enums/bungiemembershiptype.html#all","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BungieMembershipType"},{"id":702,"kind":256,"name":"IPagedQuery","url":"interfaces/ipagedquery.html","classes":"tsd-kind-interface"},{"id":703,"kind":1024,"name":"itemsPerPage","url":"interfaces/ipagedquery.html#itemsperpage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IPagedQuery"},{"id":704,"kind":1024,"name":"currentPage","url":"interfaces/ipagedquery.html#currentpage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IPagedQuery"},{"id":705,"kind":1024,"name":"requestContinuationToken","url":"interfaces/ipagedquery.html#requestcontinuationtoken","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IPagedQuery"},{"id":706,"kind":256,"name":"IInterpolationPoint","url":"interfaces/iinterpolationpoint.html","classes":"tsd-kind-interface"},{"id":707,"kind":1024,"name":"value","url":"interfaces/iinterpolationpoint.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IInterpolationPoint"},{"id":708,"kind":1024,"name":"weight","url":"interfaces/iinterpolationpoint.html#weight","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IInterpolationPoint"},{"id":709,"kind":256,"name":"IInterpolationPointFloat","url":"interfaces/iinterpolationpointfloat.html","classes":"tsd-kind-interface"},{"id":710,"kind":1024,"name":"value","url":"interfaces/iinterpolationpointfloat.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IInterpolationPointFloat"},{"id":711,"kind":1024,"name":"weight","url":"interfaces/iinterpolationpointfloat.html#weight","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IInterpolationPointFloat"},{"id":712,"kind":256,"name":"IHyperlinkReference","url":"interfaces/ihyperlinkreference.html","classes":"tsd-kind-interface"},{"id":713,"kind":1024,"name":"title","url":"interfaces/ihyperlinkreference.html#title","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IHyperlinkReference"},{"id":714,"kind":1024,"name":"url","url":"interfaces/ihyperlinkreference.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IHyperlinkReference"},{"id":715,"kind":256,"name":"IIgnoreResponse","url":"interfaces/iignoreresponse.html","classes":"tsd-kind-interface"},{"id":716,"kind":1024,"name":"isIgnored","url":"interfaces/iignoreresponse.html#isignored","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IIgnoreResponse"},{"id":717,"kind":1024,"name":"ignoreFlags","url":"interfaces/iignoreresponse.html#ignoreflags","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IIgnoreResponse"},{"id":718,"kind":4,"name":"IgnoreStatus","url":"enums/ignorestatus.html","classes":"tsd-kind-enum"},{"id":719,"kind":16,"name":"NotIgnored","url":"enums/ignorestatus.html#notignored","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"IgnoreStatus"},{"id":720,"kind":16,"name":"IgnoredUser","url":"enums/ignorestatus.html#ignoreduser","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"IgnoreStatus"},{"id":721,"kind":16,"name":"IgnoredGroup","url":"enums/ignorestatus.html#ignoredgroup","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"IgnoreStatus"},{"id":722,"kind":16,"name":"IgnoredByGroup","url":"enums/ignorestatus.html#ignoredbygroup","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"IgnoreStatus"},{"id":723,"kind":16,"name":"IgnoredPost","url":"enums/ignorestatus.html#ignoredpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"IgnoreStatus"},{"id":724,"kind":16,"name":"IgnoredTag","url":"enums/ignorestatus.html#ignoredtag","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"IgnoreStatus"},{"id":725,"kind":16,"name":"IgnoredGlobal","url":"enums/ignorestatus.html#ignoredglobal","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"IgnoreStatus"},{"id":726,"kind":4,"name":"PartnershipType","url":"enums/partnershiptype.html","classes":"tsd-kind-enum"},{"id":727,"kind":16,"name":"None","url":"enums/partnershiptype.html#none","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PartnershipType"},{"id":728,"kind":16,"name":"Twitch","url":"enums/partnershiptype.html#twitch","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PartnershipType"},{"id":729,"kind":256,"name":"ITagResponse","url":"interfaces/itagresponse.html","classes":"tsd-kind-interface"},{"id":730,"kind":1024,"name":"tagText","url":"interfaces/itagresponse.html#tagtext","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ITagResponse"},{"id":731,"kind":1024,"name":"ignoreStatus","url":"interfaces/itagresponse.html#ignorestatus","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ITagResponse"},{"id":732,"kind":65536,"name":"__type","url":"interfaces/idictionarycomponentresponse.html#data.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDictionaryComponentResponse.data"},{"id":733,"kind":65536,"name":"__type","url":"interfaces/idestinyfactiondefinition.html#tokenvalues.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyFactionDefinition.tokenValues"},{"id":734,"kind":65536,"name":"__type","url":"interfaces/idestinyactivitymodedefinition.html#activitymodemappings.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyActivityModeDefinition.activityModeMappings"},{"id":735,"kind":65536,"name":"__type","url":"interfaces/idestinyrecordtitleblock.html#titlesbygender.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyRecordTitleBlock.titlesByGender"},{"id":736,"kind":65536,"name":"__type","url":"interfaces/idestinyrecordtitleblock.html#titlesbygenderhash.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyRecordTitleBlock.titlesByGenderHash"},{"id":737,"kind":65536,"name":"__type","url":"interfaces/idestinyitemstatblockdefinition.html#stats.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyItemStatBlockDefinition.stats"},{"id":738,"kind":65536,"name":"__type","url":"interfaces/idestinystatgroupdefinition.html#overrides.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyStatGroupDefinition.overrides"},{"id":739,"kind":65536,"name":"__type","url":"interfaces/idestinyitemsourcedefinition.html#computedstats.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyItemSourceDefinition.computedStats"},{"id":740,"kind":65536,"name":"__type","url":"interfaces/idestinytalentgriddefinition.html#groups.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyTalentGridDefinition.groups"},{"id":741,"kind":65536,"name":"__type","url":"interfaces/idestinymanifest.html#mobileworldcontentpaths.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyManifest.mobileWorldContentPaths"},{"id":742,"kind":65536,"name":"__type","url":"interfaces/idestinymanifest.html#jsonworldcontentpaths.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyManifest.jsonWorldContentPaths"},{"id":743,"kind":65536,"name":"__type","url":"interfaces/idestinymanifest.html#mobilegearcdn.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyManifest.mobileGearCDN"},{"id":744,"kind":65536,"name":"__type","url":"interfaces/idestinyprofileresponse.html#characteruninstanceditemcomponents.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyProfileResponse.characterUninstancedItemComponents"},{"id":745,"kind":65536,"name":"__type","url":"interfaces/idestinykioskscomponent.html#kioskitems.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyKiosksComponent.kioskItems"},{"id":746,"kind":65536,"name":"__type","url":"interfaces/idestinyplugsetscomponent.html#plugs.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyPlugSetsComponent.plugs"},{"id":747,"kind":65536,"name":"__type","url":"interfaces/idestinyprofileprogressioncomponent.html#checklists.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyProfileProgressionComponent.checklists"},{"id":748,"kind":65536,"name":"__type","url":"interfaces/idestinypresentationnodescomponent.html#nodes.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyPresentationNodesComponent.nodes"},{"id":749,"kind":65536,"name":"__type","url":"interfaces/idestinyprofilerecordscomponent.html#records.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyProfileRecordsComponent.records"},{"id":750,"kind":65536,"name":"__type","url":"interfaces/idestinyprofilecollectiblescomponent.html#collectibles.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyProfileCollectiblesComponent.collectibles"},{"id":751,"kind":65536,"name":"__type","url":"interfaces/idestinycharactercomponent.html#stats.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyCharacterComponent.stats"},{"id":752,"kind":65536,"name":"__type","url":"interfaces/idestinyracedefinition.html#genderedracenames.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyRaceDefinition.genderedRaceNames"},{"id":753,"kind":65536,"name":"__type","url":"interfaces/idestinyracedefinition.html#genderedracenamesbygenderhash.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyRaceDefinition.genderedRaceNamesByGenderHash"},{"id":754,"kind":65536,"name":"__type","url":"interfaces/idestinyclassdefinition.html#genderedclassnames.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyClassDefinition.genderedClassNames"},{"id":755,"kind":65536,"name":"__type","url":"interfaces/idestinyclassdefinition.html#genderedclassnamesbygenderhash.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyClassDefinition.genderedClassNamesByGenderHash"},{"id":756,"kind":65536,"name":"__type","url":"interfaces/idestinycharacterprogressioncomponent.html#progressions.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyCharacterProgressionComponent.progressions"},{"id":757,"kind":65536,"name":"__type","url":"interfaces/idestinycharacterprogressioncomponent.html#factions.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyCharacterProgressionComponent.factions"},{"id":758,"kind":65536,"name":"__type","url":"interfaces/idestinycharacterprogressioncomponent.html#milestones.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyCharacterProgressionComponent.milestones"},{"id":759,"kind":65536,"name":"__type","url":"interfaces/idestinycharacterprogressioncomponent.html#uninstanceditemobjectives.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyCharacterProgressionComponent.uninstancedItemObjectives"},{"id":760,"kind":65536,"name":"__type","url":"interfaces/idestinycharacterprogressioncomponent.html#checklists.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyCharacterProgressionComponent.checklists"},{"id":761,"kind":65536,"name":"__type","url":"interfaces/idestinymilestone.html#values.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyMilestone.values"},{"id":762,"kind":65536,"name":"__type","url":"interfaces/idestinymilestonedefinition.html#quests.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyMilestoneDefinition.quests"},{"id":763,"kind":65536,"name":"__type","url":"interfaces/idestinymilestonedefinition.html#rewards.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyMilestoneDefinition.rewards"},{"id":764,"kind":65536,"name":"__type","url":"interfaces/idestinymilestonedefinition.html#values.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyMilestoneDefinition.values"},{"id":765,"kind":65536,"name":"__type","url":"interfaces/idestinymilestonequestdefinition.html#activities.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyMilestoneQuestDefinition.activities"},{"id":766,"kind":65536,"name":"__type","url":"interfaces/idestinymilestoneactivitydefinition.html#variants.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyMilestoneActivityDefinition.variants"},{"id":767,"kind":65536,"name":"__type","url":"interfaces/idestinymilestonerewardcategorydefinition.html#rewardentries.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyMilestoneRewardCategoryDefinition.rewardEntries"},{"id":768,"kind":65536,"name":"__type","url":"interfaces/idestinymilestonechallengeactivity.html#booleanactivityoptions.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyMilestoneChallengeActivity.booleanActivityOptions"},{"id":769,"kind":65536,"name":"__type","url":"interfaces/idestinycharacterrecordscomponent.html#records.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyCharacterRecordsComponent.records"},{"id":770,"kind":65536,"name":"__type","url":"interfaces/idestinycollectiblescomponent.html#collectibles.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyCollectiblesComponent.collectibles"},{"id":771,"kind":65536,"name":"__type","url":"interfaces/idestinyitemrendercomponent.html#artregions.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyItemRenderComponent.artRegions"},{"id":772,"kind":65536,"name":"__type","url":"interfaces/idestinyitemstatscomponent.html#stats.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyItemStatsComponent.stats"},{"id":773,"kind":65536,"name":"__type","url":"interfaces/idestinycurrenciescomponent.html#itemquantities.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyCurrenciesComponent.itemQuantities"},{"id":774,"kind":65536,"name":"__type","url":"interfaces/idestinyvendorsresponse.html#itemcomponents.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyVendorsResponse.itemComponents"},{"id":775,"kind":65536,"name":"__type","url":"interfaces/idestinyvendorsaleitemsetcomponent.html#saleitems.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyVendorSaleItemSetComponent.saleItems"},{"id":776,"kind":65536,"name":"__type","url":"interfaces/idestinypostgamecarnagereportentry.html#values.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyPostGameCarnageReportEntry.values"},{"id":777,"kind":65536,"name":"__type","url":"interfaces/idestinypostgamecarnagereportextendeddata.html#values.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyPostGameCarnageReportExtendedData.values"},{"id":778,"kind":65536,"name":"__type","url":"interfaces/idestinyhistoricalweaponstats.html#values.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyHistoricalWeaponStats.values"},{"id":779,"kind":65536,"name":"__type","url":"interfaces/idestinyreportreasoncategorydefinition.html#reasons.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyReportReasonCategoryDefinition.reasons"},{"id":780,"kind":65536,"name":"__type","url":"interfaces/idestinyhistoricalstatsbyperiod.html#alltime.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyHistoricalStatsByPeriod.allTime"},{"id":781,"kind":65536,"name":"__type","url":"interfaces/idestinyhistoricalstatsbyperiod.html#alltimetier1.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyHistoricalStatsByPeriod.allTimeTier1"},{"id":782,"kind":65536,"name":"__type","url":"interfaces/idestinyhistoricalstatsbyperiod.html#alltimetier2.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyHistoricalStatsByPeriod.allTimeTier2"},{"id":783,"kind":65536,"name":"__type","url":"interfaces/idestinyhistoricalstatsbyperiod.html#alltimetier3.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyHistoricalStatsByPeriod.allTimeTier3"},{"id":784,"kind":65536,"name":"__type","url":"interfaces/idestinyhistoricalstatsperiodgroup.html#values.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyHistoricalStatsPeriodGroup.values"},{"id":785,"kind":65536,"name":"__type","url":"interfaces/idestinyhistoricalstatswithmerged.html#results.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyHistoricalStatsWithMerged.results"},{"id":786,"kind":65536,"name":"__type","url":"interfaces/idestinyhistoricalstatspercharacter.html#results.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyHistoricalStatsPerCharacter.results"},{"id":787,"kind":65536,"name":"__type","url":"interfaces/idestinyaggregateactivitystats.html#values.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyAggregateActivityStats.values"},{"id":788,"kind":65536,"name":"__type","url":"interfaces/idestinypublicmilestonechallengeactivity.html#booleanactivityoptions.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IDestinyPublicMilestoneChallengeActivity.booleanActivityOptions"},{"id":789,"kind":4,"name":"GlobalAlertLevel","url":"enums/globalalertlevel.html","classes":"tsd-kind-enum"},{"id":790,"kind":16,"name":"Unkown","url":"enums/globalalertlevel.html#unkown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"GlobalAlertLevel"},{"id":791,"kind":16,"name":"Blue","url":"enums/globalalertlevel.html#blue","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"GlobalAlertLevel"},{"id":792,"kind":16,"name":"Yellow","url":"enums/globalalertlevel.html#yellow","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"GlobalAlertLevel"},{"id":793,"kind":16,"name":"Red","url":"enums/globalalertlevel.html#red","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"GlobalAlertLevel"},{"id":794,"kind":4,"name":"GlobalAlertType","url":"enums/globalalerttype.html","classes":"tsd-kind-enum"},{"id":795,"kind":16,"name":"GlobalAlert","url":"enums/globalalerttype.html#globalalert","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"GlobalAlertType"},{"id":796,"kind":16,"name":"StreamingAlert","url":"enums/globalalerttype.html#streamingalert","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"GlobalAlertType"},{"id":797,"kind":4,"name":"StatId","url":"enums/statid.html","classes":"tsd-kind-enum"},{"id":798,"kind":16,"name":"ActivitiesClearedabilityKills","url":"enums/statid.html#activitiesclearedabilitykills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":799,"kind":16,"name":"ActivitiesEntered","url":"enums/statid.html#activitiesentered","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":800,"kind":16,"name":"ActivitiesWon","url":"enums/statid.html#activitieswon","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":801,"kind":16,"name":"Assists","url":"enums/statid.html#assists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":802,"kind":16,"name":"AverageDeathDistance","url":"enums/statid.html#averagedeathdistance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":803,"kind":16,"name":"AverageKillDistance","url":"enums/statid.html#averagekilldistance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":804,"kind":16,"name":"AverageLifespan","url":"enums/statid.html#averagelifespan","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":805,"kind":16,"name":"AverageScorePerKill","url":"enums/statid.html#averagescoreperkill","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":806,"kind":16,"name":"AverageScorePerLife","url":"enums/statid.html#averagescoreperlife","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":807,"kind":16,"name":"BestSingleGameKills","url":"enums/statid.html#bestsinglegamekills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":808,"kind":16,"name":"BestSingleGameScore","url":"enums/statid.html#bestsinglegamescore","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":809,"kind":16,"name":"Completed","url":"enums/statid.html#completed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":810,"kind":16,"name":"FastestCompletionMsForActivity","url":"enums/statid.html#fastestcompletionmsforactivity","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":811,"kind":16,"name":"ActivityCompletions","url":"enums/statid.html#activitycompletions","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":812,"kind":16,"name":"ActivityDeaths","url":"enums/statid.html#activitydeaths","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":813,"kind":16,"name":"ActivityKills","url":"enums/statid.html#activitykills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":814,"kind":16,"name":"ActivitySecondsPlayed","url":"enums/statid.html#activitysecondsplayed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":815,"kind":16,"name":"ActivityWins","url":"enums/statid.html#activitywins","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":816,"kind":16,"name":"ActivityGoalsMissed","url":"enums/statid.html#activitygoalsmissed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":817,"kind":16,"name":"ActivityCompletedFailures","url":"enums/statid.html#activitycompletedfailures","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":818,"kind":16,"name":"ActivitySpecialActions","url":"enums/statid.html#activityspecialactions","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":819,"kind":16,"name":"ActivityBestGoalsHit","url":"enums/statid.html#activitybestgoalshit","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":820,"kind":16,"name":"ActivitySpecialScore","url":"enums/statid.html#activityspecialscore","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":821,"kind":16,"name":"ActivityFastestObjectiveCompletionMs","url":"enums/statid.html#activityfastestobjectivecompletionms","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":822,"kind":16,"name":"ActivityBestSingleGameScore","url":"enums/statid.html#activitybestsinglegamescore","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":823,"kind":16,"name":"ActivityKillsDeathsRatio","url":"enums/statid.html#activitykillsdeathsratio","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":824,"kind":16,"name":"ActivityKillsDeathsAssists","url":"enums/statid.html#activitykillsdeathsassists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":825,"kind":16,"name":"Deaths","url":"enums/statid.html#deaths","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":826,"kind":16,"name":"Kills","url":"enums/statid.html#kills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":827,"kind":16,"name":"KillsDeathsRatio","url":"enums/statid.html#killsdeathsratio","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":828,"kind":16,"name":"KillsDeathsAssists","url":"enums/statid.html#killsdeathsassists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":829,"kind":16,"name":"LbSingleGameKills","url":"enums/statid.html#lbsinglegamekills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":830,"kind":16,"name":"LbPrecisionKills","url":"enums/statid.html#lbprecisionkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":831,"kind":16,"name":"LbAssists","url":"enums/statid.html#lbassists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":832,"kind":16,"name":"LbDeaths","url":"enums/statid.html#lbdeaths","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":833,"kind":16,"name":"LbKills","url":"enums/statid.html#lbkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":834,"kind":16,"name":"LbObjectivesCompleted","url":"enums/statid.html#lbobjectivescompleted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":835,"kind":16,"name":"LbSingleGameScore","url":"enums/statid.html#lbsinglegamescore","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":836,"kind":16,"name":"MaximumPowerLevel","url":"enums/statid.html#maximumpowerlevel","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":837,"kind":16,"name":"MedalAbilityDawnbladeAerial","url":"enums/statid.html#medalabilitydawnbladeaerial","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":838,"kind":16,"name":"MedalAbilityDawnbladeSlam","url":"enums/statid.html#medalabilitydawnbladeslam","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":839,"kind":16,"name":"MedalAbilityFlowwalkerMulti","url":"enums/statid.html#medalabilityflowwalkermulti","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":840,"kind":16,"name":"MedalAbilityFlowwalkerQuick","url":"enums/statid.html#medalabilityflowwalkerquick","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":841,"kind":16,"name":"MedalAbilityGunslingerMulti","url":"enums/statid.html#medalabilitygunslingermulti","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":842,"kind":16,"name":"MedalAbilityGunslingerQuick","url":"enums/statid.html#medalabilitygunslingerquick","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":843,"kind":16,"name":"MedalAbilityJuggernautCombo","url":"enums/statid.html#medalabilityjuggernautcombo","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":844,"kind":16,"name":"MedalAbilityJuggernautSlam","url":"enums/statid.html#medalabilityjuggernautslam","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":845,"kind":16,"name":"MedalAbilityNightstalkerLongRange","url":"enums/statid.html#medalabilitynightstalkerlongrange","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":846,"kind":16,"name":"MedalAbilityNightstalkerTetherQuick","url":"enums/statid.html#medalabilitynightstalkertetherquick","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":847,"kind":16,"name":"MedalAbilitySentinelCombo","url":"enums/statid.html#medalabilitysentinelcombo","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":848,"kind":16,"name":"MedalAbilitySentinelWard","url":"enums/statid.html#medalabilitysentinelward","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":849,"kind":16,"name":"MedalAbilityStormcallerLandfall","url":"enums/statid.html#medalabilitystormcallerlandfall","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":850,"kind":16,"name":"MedalAbilityStormcallerMulti","url":"enums/statid.html#medalabilitystormcallermulti","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":851,"kind":16,"name":"MedalAbilitySunbreakerLongRange","url":"enums/statid.html#medalabilitysunbreakerlongrange","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":852,"kind":16,"name":"MedalAbilitySunbreakerMulti","url":"enums/statid.html#medalabilitysunbreakermulti","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":853,"kind":16,"name":"MedalAbilityVoidwalkerDistance","url":"enums/statid.html#medalabilityvoidwalkerdistance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":854,"kind":16,"name":"MedalAbilityVoidwalkerVortex","url":"enums/statid.html#medalabilityvoidwalkervortex","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":855,"kind":16,"name":"MedalAvenger","url":"enums/statid.html#medalavenger","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":856,"kind":16,"name":"MedalControlAdvantageHold","url":"enums/statid.html#medalcontroladvantagehold","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":857,"kind":16,"name":"MedalControlAdvantageStreak","url":"enums/statid.html#medalcontroladvantagestreak","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":858,"kind":16,"name":"MedalControlCaptureAllZones","url":"enums/statid.html#medalcontrolcaptureallzones","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":859,"kind":16,"name":"MedalControlMostAdvantage","url":"enums/statid.html#medalcontrolmostadvantage","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":860,"kind":16,"name":"MedalControlPerimeterKill","url":"enums/statid.html#medalcontrolperimeterkill","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":861,"kind":16,"name":"MedalControlPowerPlayWipe","url":"enums/statid.html#medalcontrolpowerplaywipe","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":862,"kind":16,"name":"MedalCountdownDefense","url":"enums/statid.html#medalcountdowndefense","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":863,"kind":16,"name":"MedalCountdownDefusedLastStand","url":"enums/statid.html#medalcountdowndefusedlaststand","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":864,"kind":16,"name":"MedalCountdownDefusedMulti","url":"enums/statid.html#medalcountdowndefusedmulti","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":865,"kind":16,"name":"MedalCountdownDetonated","url":"enums/statid.html#medalcountdowndetonated","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":866,"kind":16,"name":"MedalCountdownPerfect","url":"enums/statid.html#medalcountdownperfect","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":867,"kind":16,"name":"MedalCountdownRoundAllAlive","url":"enums/statid.html#medalcountdownroundallalive","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":868,"kind":16,"name":"MedalCycle","url":"enums/statid.html#medalcycle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":869,"kind":16,"name":"MedalDefeatHunterDodge","url":"enums/statid.html#medaldefeathunterdodge","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":870,"kind":16,"name":"MedalDefeatTitanBrace","url":"enums/statid.html#medaldefeattitanbrace","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":871,"kind":16,"name":"MedalDefeatWarlockSigil","url":"enums/statid.html#medaldefeatwarlocksigil","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":872,"kind":16,"name":"MedalDefense","url":"enums/statid.html#medaldefense","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":873,"kind":16,"name":"MedalMatchBlowout","url":"enums/statid.html#medalmatchblowout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":874,"kind":16,"name":"MedalMatchComeback","url":"enums/statid.html#medalmatchcomeback","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":875,"kind":16,"name":"MedalMatchMostDamage","url":"enums/statid.html#medalmatchmostdamage","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":876,"kind":16,"name":"MedalMatchNeverTrailed","url":"enums/statid.html#medalmatchnevertrailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":877,"kind":16,"name":"MedalMatchOvertime","url":"enums/statid.html#medalmatchovertime","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":878,"kind":16,"name":"MedalMatchUndefeated","url":"enums/statid.html#medalmatchundefeated","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":879,"kind":16,"name":"MedalMulti2x","url":"enums/statid.html#medalmulti2x","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":880,"kind":16,"name":"MedalMulti3x","url":"enums/statid.html#medalmulti3x","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":881,"kind":16,"name":"MedalMulti4x","url":"enums/statid.html#medalmulti4x","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":882,"kind":16,"name":"MedalMultiEntireTeam","url":"enums/statid.html#medalmultientireteam","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":883,"kind":16,"name":"MedalPayback","url":"enums/statid.html#medalpayback","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":884,"kind":16,"name":"MedalQuickStrike","url":"enums/statid.html#medalquickstrike","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":885,"kind":16,"name":"MedalStreak10x","url":"enums/statid.html#medalstreak10x","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":886,"kind":16,"name":"MedalStreak5x","url":"enums/statid.html#medalstreak5x","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":887,"kind":16,"name":"MedalStreakAbsurd","url":"enums/statid.html#medalstreakabsurd","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":888,"kind":16,"name":"MedalStreakCombined","url":"enums/statid.html#medalstreakcombined","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":889,"kind":16,"name":"MedalStreakShutdown","url":"enums/statid.html#medalstreakshutdown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":890,"kind":16,"name":"MedalStreakTeam","url":"enums/statid.html#medalstreakteam","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":891,"kind":16,"name":"MedalSuperShutdown","url":"enums/statid.html#medalsupershutdown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":892,"kind":16,"name":"MedalSupremacyCrestCreditStreak","url":"enums/statid.html#medalsupremacycrestcreditstreak","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":893,"kind":16,"name":"MedalSupremacyFirstCrest","url":"enums/statid.html#medalsupremacyfirstcrest","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":894,"kind":16,"name":"MedalSupremacyNeverCollected","url":"enums/statid.html#medalsupremacynevercollected","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":895,"kind":16,"name":"MedalSupremacyPerfectSecureRate","url":"enums/statid.html#medalsupremacyperfectsecurerate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":896,"kind":16,"name":"MedalSupremacyRecoverStreak","url":"enums/statid.html#medalsupremacyrecoverstreak","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":897,"kind":16,"name":"MedalSupremacySecureStreak","url":"enums/statid.html#medalsupremacysecurestreak","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":898,"kind":16,"name":"MedalSurvivalComeback","url":"enums/statid.html#medalsurvivalcomeback","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":899,"kind":16,"name":"MedalSurvivalKnockout","url":"enums/statid.html#medalsurvivalknockout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":900,"kind":16,"name":"MedalSurvivalQuickWipe","url":"enums/statid.html#medalsurvivalquickwipe","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":901,"kind":16,"name":"MedalSurvivalTeamUndefeated","url":"enums/statid.html#medalsurvivalteamundefeated","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":902,"kind":16,"name":"MedalSurvivalUndefeated","url":"enums/statid.html#medalsurvivalundefeated","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":903,"kind":16,"name":"MedalSurvivalWinLastStand","url":"enums/statid.html#medalsurvivalwinlaststand","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":904,"kind":16,"name":"MedalWeaponAuto","url":"enums/statid.html#medalweaponauto","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":905,"kind":16,"name":"MedalWeaponFusion","url":"enums/statid.html#medalweaponfusion","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":906,"kind":16,"name":"MedalWeaponGrenade","url":"enums/statid.html#medalweapongrenade","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":907,"kind":16,"name":"MedalWeaponHandCannon","url":"enums/statid.html#medalweaponhandcannon","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":908,"kind":16,"name":"MedalWeaponPulse","url":"enums/statid.html#medalweaponpulse","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":909,"kind":16,"name":"MedalWeaponRocket","url":"enums/statid.html#medalweaponrocket","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":910,"kind":16,"name":"MedalWeaponScout","url":"enums/statid.html#medalweaponscout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":911,"kind":16,"name":"MedalWeaponShotgun","url":"enums/statid.html#medalweaponshotgun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":912,"kind":16,"name":"MedalWeaponSidearm","url":"enums/statid.html#medalweaponsidearm","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":913,"kind":16,"name":"MedalWeaponSmg","url":"enums/statid.html#medalweaponsmg","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":914,"kind":16,"name":"MedalWeaponSniper","url":"enums/statid.html#medalweaponsniper","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":915,"kind":16,"name":"MedalWeaponSword","url":"enums/statid.html#medalweaponsword","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":916,"kind":16,"name":"MedalsUnknown","url":"enums/statid.html#medalsunknown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":917,"kind":16,"name":"AllMedalsScore","url":"enums/statid.html#allmedalsscore","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":918,"kind":16,"name":"AllMedalsEarned","url":"enums/statid.html#allmedalsearned","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":919,"kind":16,"name":"ObjectivesCompleted","url":"enums/statid.html#objectivescompleted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":920,"kind":16,"name":"PrecisionKills","url":"enums/statid.html#precisionkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":921,"kind":16,"name":"ResurrectionsPerformed","url":"enums/statid.html#resurrectionsperformed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":922,"kind":16,"name":"ResurrectionsReceived","url":"enums/statid.html#resurrectionsreceived","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":923,"kind":16,"name":"Score","url":"enums/statid.html#score","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":924,"kind":16,"name":"SecondsPlayed","url":"enums/statid.html#secondsplayed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":925,"kind":16,"name":"ActivityDurationSeconds","url":"enums/statid.html#activitydurationseconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":926,"kind":16,"name":"Standing","url":"enums/statid.html#standing","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":927,"kind":16,"name":"Suicides","url":"enums/statid.html#suicides","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":928,"kind":16,"name":"Team","url":"enums/statid.html#team","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":929,"kind":16,"name":"TotalDeathDistance","url":"enums/statid.html#totaldeathdistance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":930,"kind":16,"name":"TotalKillDistance","url":"enums/statid.html#totalkilldistance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":931,"kind":16,"name":"WeaponPrecisionKillsAutoRifle","url":"enums/statid.html#weaponprecisionkillsautorifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":932,"kind":16,"name":"WeaponPrecisionKillsFusionRifle","url":"enums/statid.html#weaponprecisionkillsfusionrifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":933,"kind":16,"name":"WeaponPrecisionKillsGrenade","url":"enums/statid.html#weaponprecisionkillsgrenade","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":934,"kind":16,"name":"WeaponPrecisionKillsHandCannon","url":"enums/statid.html#weaponprecisionkillshandcannon","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":935,"kind":16,"name":"WeaponPrecisionKillsMachinegun","url":"enums/statid.html#weaponprecisionkillsmachinegun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":936,"kind":16,"name":"WeaponPrecisionKillsMelee","url":"enums/statid.html#weaponprecisionkillsmelee","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":937,"kind":16,"name":"WeaponPrecisionKillsPulseRifle","url":"enums/statid.html#weaponprecisionkillspulserifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":938,"kind":16,"name":"WeaponPrecisionKillsRocketLauncher","url":"enums/statid.html#weaponprecisionkillsrocketlauncher","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":939,"kind":16,"name":"WeaponPrecisionKillsScoutRifle","url":"enums/statid.html#weaponprecisionkillsscoutrifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":940,"kind":16,"name":"WeaponPrecisionKillsShotgun","url":"enums/statid.html#weaponprecisionkillsshotgun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":941,"kind":16,"name":"WeaponPrecisionKillsSniper","url":"enums/statid.html#weaponprecisionkillssniper","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":942,"kind":16,"name":"WeaponPrecisionKillsSubmachinegun","url":"enums/statid.html#weaponprecisionkillssubmachinegun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":943,"kind":16,"name":"WeaponPrecisionKillsSuper","url":"enums/statid.html#weaponprecisionkillssuper","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":944,"kind":16,"name":"WeaponPrecisionKillsRelic","url":"enums/statid.html#weaponprecisionkillsrelic","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":945,"kind":16,"name":"WeaponPrecisionKillsSideArm","url":"enums/statid.html#weaponprecisionkillssidearm","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":946,"kind":16,"name":"WeaponKillsAutoRifle","url":"enums/statid.html#weaponkillsautorifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":947,"kind":16,"name":"WeaponKillsFusionRifle","url":"enums/statid.html#weaponkillsfusionrifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":948,"kind":16,"name":"WeaponKillsGrenade","url":"enums/statid.html#weaponkillsgrenade","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":949,"kind":16,"name":"WeaponKillsHandCannon","url":"enums/statid.html#weaponkillshandcannon","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":950,"kind":16,"name":"WeaponKillsMachinegun","url":"enums/statid.html#weaponkillsmachinegun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":951,"kind":16,"name":"WeaponKillsMelee","url":"enums/statid.html#weaponkillsmelee","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":952,"kind":16,"name":"WeaponKillsPulseRifle","url":"enums/statid.html#weaponkillspulserifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":953,"kind":16,"name":"WeaponKillsRocketLauncher","url":"enums/statid.html#weaponkillsrocketlauncher","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":954,"kind":16,"name":"WeaponKillsScoutRifle","url":"enums/statid.html#weaponkillsscoutrifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":955,"kind":16,"name":"WeaponKillsShotgun","url":"enums/statid.html#weaponkillsshotgun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":956,"kind":16,"name":"WeaponKillsSniper","url":"enums/statid.html#weaponkillssniper","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":957,"kind":16,"name":"WeaponKillsSubmachinegun","url":"enums/statid.html#weaponkillssubmachinegun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":958,"kind":16,"name":"WeaponKillsSuper","url":"enums/statid.html#weaponkillssuper","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":959,"kind":16,"name":"WeaponKillsRelic","url":"enums/statid.html#weaponkillsrelic","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":960,"kind":16,"name":"WeaponKillsSideArm","url":"enums/statid.html#weaponkillssidearm","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":961,"kind":16,"name":"WeaponKillsSword","url":"enums/statid.html#weaponkillssword","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":962,"kind":16,"name":"WeaponKillsAbility","url":"enums/statid.html#weaponkillsability","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":963,"kind":16,"name":"WeaponBestType","url":"enums/statid.html#weaponbesttype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":964,"kind":16,"name":"WeaponKillsPrecisionKillsAutoRifle","url":"enums/statid.html#weaponkillsprecisionkillsautorifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":965,"kind":16,"name":"WeaponKillsPrecisionKillsFusionRifle","url":"enums/statid.html#weaponkillsprecisionkillsfusionrifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":966,"kind":16,"name":"WeaponKillsPrecisionKillsGrenade","url":"enums/statid.html#weaponkillsprecisionkillsgrenade","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":967,"kind":16,"name":"WeaponKillsPrecisionKillsHandCannon","url":"enums/statid.html#weaponkillsprecisionkillshandcannon","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":968,"kind":16,"name":"WeaponKillsPrecisionKillsMachinegun","url":"enums/statid.html#weaponkillsprecisionkillsmachinegun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":969,"kind":16,"name":"WeaponKillsPrecisionKillsMelee","url":"enums/statid.html#weaponkillsprecisionkillsmelee","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":970,"kind":16,"name":"WeaponKillsPrecisionKillsPulseRifle","url":"enums/statid.html#weaponkillsprecisionkillspulserifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":971,"kind":16,"name":"WeaponKillsPrecisionKillsRocketLauncher","url":"enums/statid.html#weaponkillsprecisionkillsrocketlauncher","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":972,"kind":16,"name":"WeaponKillsPrecisionKillsScoutRifle","url":"enums/statid.html#weaponkillsprecisionkillsscoutrifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":973,"kind":16,"name":"WeaponKillsPrecisionKillsShotgun","url":"enums/statid.html#weaponkillsprecisionkillsshotgun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":974,"kind":16,"name":"WeaponKillsPrecisionKillsSniper","url":"enums/statid.html#weaponkillsprecisionkillssniper","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":975,"kind":16,"name":"WeaponKillsPrecisionKillsSubmachinegun","url":"enums/statid.html#weaponkillsprecisionkillssubmachinegun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":976,"kind":16,"name":"WeaponKillsPrecisionKillsSuper","url":"enums/statid.html#weaponkillsprecisionkillssuper","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":977,"kind":16,"name":"WeaponKillsPrecisionKillsRelic","url":"enums/statid.html#weaponkillsprecisionkillsrelic","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":978,"kind":16,"name":"WeaponKillsPrecisionKillsSideArm","url":"enums/statid.html#weaponkillsprecisionkillssidearm","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":979,"kind":16,"name":"WinLossRatio","url":"enums/statid.html#winlossratio","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":980,"kind":16,"name":"UniqueWeaponAssists","url":"enums/statid.html#uniqueweaponassists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":981,"kind":16,"name":"UniqueWeaponAssistDamage","url":"enums/statid.html#uniqueweaponassistdamage","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":982,"kind":16,"name":"UniqueWeaponKills","url":"enums/statid.html#uniqueweaponkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":983,"kind":16,"name":"UniqueWeaponPrecisionKills","url":"enums/statid.html#uniqueweaponprecisionkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":984,"kind":16,"name":"UniqueWeaponKillsPrecisionKills","url":"enums/statid.html#uniqueweaponkillsprecisionkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":985,"kind":16,"name":"AllParticipantsCount","url":"enums/statid.html#allparticipantscount","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":986,"kind":16,"name":"AllParticipantsScore","url":"enums/statid.html#allparticipantsscore","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":987,"kind":16,"name":"AllParticipantsTimePlayed","url":"enums/statid.html#allparticipantstimeplayed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":988,"kind":16,"name":"ActivityAssists","url":"enums/statid.html#activityassists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":989,"kind":16,"name":"CompletionReason","url":"enums/statid.html#completionreason","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":990,"kind":16,"name":"FireteamId","url":"enums/statid.html#fireteamid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":991,"kind":16,"name":"LongestKillSpree","url":"enums/statid.html#longestkillspree","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":992,"kind":16,"name":"LongestSingleLife","url":"enums/statid.html#longestsinglelife","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":993,"kind":16,"name":"MostPrecisionKills","url":"enums/statid.html#mostprecisionkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":994,"kind":16,"name":"OrbsDropped","url":"enums/statid.html#orbsdropped","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":995,"kind":16,"name":"OrbsGathered","url":"enums/statid.html#orbsgathered","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":996,"kind":16,"name":"StartSeconds","url":"enums/statid.html#startseconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":997,"kind":16,"name":"TimePlayedSeconds","url":"enums/statid.html#timeplayedseconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":998,"kind":16,"name":"PlayerCount","url":"enums/statid.html#playercount","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":999,"kind":16,"name":"ActivityPrecisionKills","url":"enums/statid.html#activityprecisionkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1000,"kind":16,"name":"PublicEventsCompleted","url":"enums/statid.html#publiceventscompleted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1001,"kind":16,"name":"PublicEventsJoined","url":"enums/statid.html#publiceventsjoined","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1002,"kind":16,"name":"RemainingTimeAfterQuitSeconds","url":"enums/statid.html#remainingtimeafterquitseconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1003,"kind":16,"name":"TeamScore","url":"enums/statid.html#teamscore","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1004,"kind":16,"name":"TotalActivityDurationSeconds","url":"enums/statid.html#totalactivitydurationseconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1005,"kind":16,"name":"DailyMedalsEarned","url":"enums/statid.html#dailymedalsearned","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1006,"kind":16,"name":"CombatRating","url":"enums/statid.html#combatrating","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1007,"kind":16,"name":"LbMostPrecisionKills","url":"enums/statid.html#lbmostprecisionkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1008,"kind":16,"name":"LbLongestKillSpree","url":"enums/statid.html#lblongestkillspree","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1009,"kind":16,"name":"LbLongestKillDistance","url":"enums/statid.html#lblongestkilldistance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1010,"kind":16,"name":"LbFastestCompletionMs","url":"enums/statid.html#lbfastestcompletionms","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1011,"kind":16,"name":"LbLongestSingleLife","url":"enums/statid.html#lblongestsinglelife","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1012,"kind":16,"name":"FastestCompletionMs","url":"enums/statid.html#fastestcompletionms","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1013,"kind":16,"name":"LongestKillDistance","url":"enums/statid.html#longestkilldistance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1014,"kind":16,"name":"HighestCharacterLevel","url":"enums/statid.html#highestcharacterlevel","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1015,"kind":16,"name":"HighestLightLevel","url":"enums/statid.html#highestlightlevel","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1016,"kind":16,"name":"HighestSandboxLevel","url":"enums/statid.html#highestsandboxlevel","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1017,"kind":16,"name":"SparksCaptured","url":"enums/statid.html#sparkscaptured","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1018,"kind":16,"name":"SlamDunks","url":"enums/statid.html#slamdunks","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1019,"kind":16,"name":"StyleDunks","url":"enums/statid.html#styledunks","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1020,"kind":16,"name":"DunkKills","url":"enums/statid.html#dunkkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1021,"kind":16,"name":"CarrierKills","url":"enums/statid.html#carrierkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1022,"kind":16,"name":"ActivityGatesHit","url":"enums/statid.html#activitygateshit","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1023,"kind":16,"name":"RaceCompletionSeconds","url":"enums/statid.html#racecompletionseconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1024,"kind":16,"name":"GatesHit","url":"enums/statid.html#gateshit","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1025,"kind":16,"name":"RaceCompletionMilliseconds","url":"enums/statid.html#racecompletionmilliseconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1026,"kind":4,"name":"TypeDefinition","url":"enums/typedefinition.html","classes":"tsd-kind-enum"},{"id":1027,"kind":16,"name":"DestinyActivityGraphDefinition","url":"enums/typedefinition.html#destinyactivitygraphdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1028,"kind":16,"name":"DestinyActivityModeDefinition","url":"enums/typedefinition.html#destinyactivitymodedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1029,"kind":16,"name":"DestinyActivityModifierDefinition","url":"enums/typedefinition.html#destinyactivitymodifierdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1030,"kind":16,"name":"DestinyActivityTypeDefinition","url":"enums/typedefinition.html#destinyactivitytypedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1031,"kind":16,"name":"DestinyBondDefinition","url":"enums/typedefinition.html#destinybonddefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1032,"kind":16,"name":"DestinyClassDefinition","url":"enums/typedefinition.html#destinyclassdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1033,"kind":16,"name":"DestinyDamageTypeDefinition","url":"enums/typedefinition.html#destinydamagetypedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1034,"kind":16,"name":"DestinyDestinationDefinition","url":"enums/typedefinition.html#destinydestinationdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1035,"kind":16,"name":"DestinyEnemyRaceDefinition","url":"enums/typedefinition.html#destinyenemyracedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1036,"kind":16,"name":"DestinyFactionDefinition","url":"enums/typedefinition.html#destinyfactiondefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1037,"kind":16,"name":"DestinyGenderDefinition","url":"enums/typedefinition.html#destinygenderdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1038,"kind":16,"name":"DestinyHistoricalStatsDefinition","url":"enums/typedefinition.html#destinyhistoricalstatsdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1039,"kind":16,"name":"DestinyInventoryBucketDefinition","url":"enums/typedefinition.html#destinyinventorybucketdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1040,"kind":16,"name":"DestinyInventoryItemDefinition","url":"enums/typedefinition.html#destinyinventoryitemdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1041,"kind":16,"name":"DestinyItemCategoryDefinition","url":"enums/typedefinition.html#destinyitemcategorydefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1042,"kind":16,"name":"DestinyItemTierTypeDefinition","url":"enums/typedefinition.html#destinyitemtiertypedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1043,"kind":16,"name":"DestinyLocationDefinition","url":"enums/typedefinition.html#destinylocationdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1044,"kind":16,"name":"DestinyLoreDefinition","url":"enums/typedefinition.html#destinyloredefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1045,"kind":16,"name":"DestinyMedalTierDefinition","url":"enums/typedefinition.html#destinymedaltierdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1046,"kind":16,"name":"DestinyMilestoneDefinition","url":"enums/typedefinition.html#destinymilestonedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1047,"kind":16,"name":"DestinyObjectiveDefinition","url":"enums/typedefinition.html#destinyobjectivedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1048,"kind":16,"name":"DestinyPlaceDefinition","url":"enums/typedefinition.html#destinyplacedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1049,"kind":16,"name":"DestinyProgressionDefinition","url":"enums/typedefinition.html#destinyprogressiondefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1050,"kind":16,"name":"DestinyProgressionLevelRequirementDefinition","url":"enums/typedefinition.html#destinyprogressionlevelrequirementdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1051,"kind":16,"name":"DestinyRaceDefinition","url":"enums/typedefinition.html#destinyracedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1052,"kind":16,"name":"DestinyRewardSourceDefinition","url":"enums/typedefinition.html#destinyrewardsourcedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1053,"kind":16,"name":"DestinySackRewardItemListDefinition","url":"enums/typedefinition.html#destinysackrewarditemlistdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1054,"kind":16,"name":"DestinySandboxPerkDefinition","url":"enums/typedefinition.html#destinysandboxperkdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1055,"kind":16,"name":"DestinySocketCategoryDefinition","url":"enums/typedefinition.html#destinysocketcategorydefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1056,"kind":16,"name":"DestinySocketTypeDefinition","url":"enums/typedefinition.html#destinysockettypedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1057,"kind":16,"name":"DestinyStatDefinition","url":"enums/typedefinition.html#destinystatdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1058,"kind":16,"name":"DestinyStatGroupDefinition","url":"enums/typedefinition.html#destinystatgroupdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1059,"kind":16,"name":"DestinyTalentGridDefinition","url":"enums/typedefinition.html#destinytalentgriddefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1060,"kind":16,"name":"DestinyUnlockDefinition","url":"enums/typedefinition.html#destinyunlockdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1061,"kind":16,"name":"DestinyVendorCategoryDefinition","url":"enums/typedefinition.html#destinyvendorcategorydefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1062,"kind":16,"name":"DestinyVendorDefinition","url":"enums/typedefinition.html#destinyvendordefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1063,"kind":256,"name":"ITravelerConfig","url":"interfaces/itravelerconfig.html","classes":"tsd-kind-interface"},{"id":1064,"kind":1024,"name":"apikey","url":"interfaces/itravelerconfig.html#apikey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ITravelerConfig"},{"id":1065,"kind":1024,"name":"userAgent","url":"interfaces/itravelerconfig.html#useragent","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ITravelerConfig"},{"id":1066,"kind":1024,"name":"oauthClientId","url":"interfaces/itravelerconfig.html#oauthclientid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ITravelerConfig"},{"id":1067,"kind":1024,"name":"oauthClientSecret","url":"interfaces/itravelerconfig.html#oauthclientsecret","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ITravelerConfig"},{"id":1068,"kind":1024,"name":"debug","url":"interfaces/itravelerconfig.html#debug","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ITravelerConfig"},{"id":1069,"kind":256,"name":"IStreamInfo","url":"interfaces/istreaminfo.html","classes":"tsd-kind-interface"},{"id":1070,"kind":1024,"name":"ChannelName","url":"interfaces/istreaminfo.html#channelname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IStreamInfo"},{"id":1071,"kind":256,"name":"IGlobalAlert","url":"interfaces/iglobalalert.html","classes":"tsd-kind-interface"},{"id":1072,"kind":1024,"name":"AlertKey","url":"interfaces/iglobalalert.html#alertkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IGlobalAlert"},{"id":1073,"kind":1024,"name":"AlertHtml","url":"interfaces/iglobalalert.html#alerthtml","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IGlobalAlert"},{"id":1074,"kind":1024,"name":"AlerTimestamp","url":"interfaces/iglobalalert.html#alertimestamp","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IGlobalAlert"},{"id":1075,"kind":1024,"name":"AlertLink","url":"interfaces/iglobalalert.html#alertlink","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IGlobalAlert"},{"id":1076,"kind":1024,"name":"AlertLevel","url":"interfaces/iglobalalert.html#alertlevel","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IGlobalAlert"},{"id":1077,"kind":1024,"name":"AlertType","url":"interfaces/iglobalalert.html#alerttype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IGlobalAlert"},{"id":1078,"kind":1024,"name":"StreamInfo","url":"interfaces/iglobalalert.html#streaminfo","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IGlobalAlert"},{"id":1079,"kind":256,"name":"IDictionaryResponse","url":"interfaces/idictionaryresponse.html","classes":"tsd-kind-interface tsd-has-type-parameter"},{"id":1080,"kind":256,"name":"IQueryStringParameters","url":"interfaces/iquerystringparameters.html","classes":"tsd-kind-interface"},{"id":1081,"kind":1024,"name":"components","url":"interfaces/iquerystringparameters.html#components","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IQueryStringParameters"},{"id":1082,"kind":1024,"name":"modes","url":"interfaces/iquerystringparameters.html#modes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IQueryStringParameters"},{"id":1083,"kind":1024,"name":"mode","url":"interfaces/iquerystringparameters.html#mode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IQueryStringParameters"},{"id":1084,"kind":1024,"name":"maxtop","url":"interfaces/iquerystringparameters.html#maxtop","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IQueryStringParameters"},{"id":1085,"kind":1024,"name":"statid","url":"interfaces/iquerystringparameters.html#statid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IQueryStringParameters"},{"id":1086,"kind":1024,"name":"page","url":"interfaces/iquerystringparameters.html#page","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IQueryStringParameters"},{"id":1087,"kind":1024,"name":"dayend","url":"interfaces/iquerystringparameters.html#dayend","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IQueryStringParameters"},{"id":1088,"kind":1024,"name":"daystart","url":"interfaces/iquerystringparameters.html#daystart","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IQueryStringParameters"},{"id":1089,"kind":1024,"name":"groups","url":"interfaces/iquerystringparameters.html#groups","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IQueryStringParameters"},{"id":1090,"kind":1024,"name":"periodType","url":"interfaces/iquerystringparameters.html#periodtype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IQueryStringParameters"},{"id":1091,"kind":1024,"name":"count","url":"interfaces/iquerystringparameters.html#count","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IQueryStringParameters"},{"id":1092,"kind":256,"name":"IOAuthResponse","url":"interfaces/ioauthresponse.html","classes":"tsd-kind-interface"},{"id":1093,"kind":1024,"name":"access_token","url":"interfaces/ioauthresponse.html#access_token","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IOAuthResponse"},{"id":1094,"kind":1024,"name":"token_type","url":"interfaces/ioauthresponse.html#token_type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IOAuthResponse"},{"id":1095,"kind":1024,"name":"expires_in","url":"interfaces/ioauthresponse.html#expires_in","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IOAuthResponse"},{"id":1096,"kind":1024,"name":"refresh_token","url":"interfaces/ioauthresponse.html#refresh_token","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IOAuthResponse"},{"id":1097,"kind":1024,"name":"refresh_expires_in","url":"interfaces/ioauthresponse.html#refresh_expires_in","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IOAuthResponse"},{"id":1098,"kind":1024,"name":"membership_id","url":"interfaces/ioauthresponse.html#membership_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IOAuthResponse"},{"id":1099,"kind":128,"name":"OAuthError","url":"classes/oautherror.html","classes":"tsd-kind-class"},{"id":1100,"kind":512,"name":"constructor","url":"classes/oautherror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"OAuthError"},{"id":1101,"kind":1024,"name":"name","url":"classes/oautherror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"OAuthError"},{"id":1102,"kind":1024,"name":"message","url":"classes/oautherror.html#message","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"OAuthError"},{"id":1103,"kind":1024,"name":"stack","url":"classes/oautherror.html#stack","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"OAuthError"},{"id":1104,"kind":1024,"name":"Error","url":"classes/oautherror.html#error","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"OAuthError"},{"id":1105,"kind":128,"name":"Destiny2Resource","url":"classes/destiny2resource.html","classes":"tsd-kind-class"},{"id":1106,"kind":1024,"name":"resourcePath","url":"classes/destiny2resource.html#resourcepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"Destiny2Resource"},{"id":1107,"kind":512,"name":"constructor","url":"classes/destiny2resource.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"Destiny2Resource"},{"id":1108,"kind":2048,"name":"getDestinyManifest","url":"classes/destiny2resource.html#getdestinymanifest","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1109,"kind":2048,"name":"getDestinyEntityDefinition","url":"classes/destiny2resource.html#getdestinyentitydefinition","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1110,"kind":2048,"name":"searchDestinyPlayer","url":"classes/destiny2resource.html#searchdestinyplayer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1111,"kind":2048,"name":"getLinkedProfiles","url":"classes/destiny2resource.html#getlinkedprofiles","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1112,"kind":2048,"name":"getProfile","url":"classes/destiny2resource.html#getprofile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1113,"kind":2048,"name":"getCharacter","url":"classes/destiny2resource.html#getcharacter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1114,"kind":2048,"name":"getClanWeeklyRewardState","url":"classes/destiny2resource.html#getclanweeklyrewardstate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1115,"kind":2048,"name":"getItem","url":"classes/destiny2resource.html#getitem","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1116,"kind":2048,"name":"getVendors","url":"classes/destiny2resource.html#getvendors","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1117,"kind":2048,"name":"getVendor","url":"classes/destiny2resource.html#getvendor","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1118,"kind":2048,"name":"getCollectibleNodeDetails","url":"classes/destiny2resource.html#getcollectiblenodedetails","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1119,"kind":2048,"name":"getPostGameCarnageReport","url":"classes/destiny2resource.html#getpostgamecarnagereport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1120,"kind":2048,"name":"getHistoricalStatsDefinition","url":"classes/destiny2resource.html#gethistoricalstatsdefinition","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1121,"kind":2048,"name":"getClanLeaderboards","url":"classes/destiny2resource.html#getclanleaderboards","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1122,"kind":2048,"name":"getClanAggregateStats","url":"classes/destiny2resource.html#getclanaggregatestats","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1123,"kind":2048,"name":"getLeaderboards","url":"classes/destiny2resource.html#getleaderboards","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1124,"kind":2048,"name":"getLeaderboardsForCharacter","url":"classes/destiny2resource.html#getleaderboardsforcharacter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1125,"kind":2048,"name":"searchDestinyEntities","url":"classes/destiny2resource.html#searchdestinyentities","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1126,"kind":2048,"name":"getHistoricalStats","url":"classes/destiny2resource.html#gethistoricalstats","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1127,"kind":2048,"name":"getHistoricalStatsForAccount","url":"classes/destiny2resource.html#gethistoricalstatsforaccount","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1128,"kind":2048,"name":"getActivityHistory","url":"classes/destiny2resource.html#getactivityhistory","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1129,"kind":2048,"name":"getUniqueWeaponHistory","url":"classes/destiny2resource.html#getuniqueweaponhistory","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1130,"kind":2048,"name":"getDestinyAggregateActivityStats","url":"classes/destiny2resource.html#getdestinyaggregateactivitystats","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1131,"kind":2048,"name":"getPublicMilestoneContent","url":"classes/destiny2resource.html#getpublicmilestonecontent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1132,"kind":2048,"name":"getPublicMilestones","url":"classes/destiny2resource.html#getpublicmilestones","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1133,"kind":2048,"name":"downloadManifest","url":"classes/destiny2resource.html#downloadmanifest","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1134,"kind":2048,"name":"downloadManifestJSON","url":"classes/destiny2resource.html#downloadmanifestjson","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1135,"kind":1024,"name":"httpService","url":"classes/destiny2resource.html#httpservice","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"Destiny2Resource"},{"id":1136,"kind":1024,"name":"basePath","url":"classes/destiny2resource.html#basepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"Destiny2Resource"},{"id":1137,"kind":128,"name":"GlobalResource","url":"classes/globalresource.html","classes":"tsd-kind-class"},{"id":1138,"kind":1024,"name":"resourcePath","url":"classes/globalresource.html#resourcepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"GlobalResource"},{"id":1139,"kind":512,"name":"constructor","url":"classes/globalresource.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"GlobalResource"},{"id":1140,"kind":2048,"name":"getAvailableLocales","url":"classes/globalresource.html#getavailablelocales","classes":"tsd-kind-method tsd-parent-kind-class","parent":"GlobalResource"},{"id":1141,"kind":2048,"name":"getCommonSettings","url":"classes/globalresource.html#getcommonsettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"GlobalResource"},{"id":1142,"kind":2048,"name":"getGlobalAlerts","url":"classes/globalresource.html#getglobalalerts","classes":"tsd-kind-method tsd-parent-kind-class","parent":"GlobalResource"},{"id":1143,"kind":1024,"name":"httpService","url":"classes/globalresource.html#httpservice","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"GlobalResource"},{"id":1144,"kind":1024,"name":"basePath","url":"classes/globalresource.html#basepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"GlobalResource"},{"id":1145,"kind":128,"name":"OAuthResource","url":"classes/oauthresource.html","classes":"tsd-kind-class"},{"id":1146,"kind":1024,"name":"resourcePath","url":"classes/oauthresource.html#resourcepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"OAuthResource"},{"id":1147,"kind":1024,"name":"userAgent","url":"classes/oauthresource.html#useragent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"OAuthResource"},{"id":1148,"kind":512,"name":"constructor","url":"classes/oauthresource.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"OAuthResource"},{"id":1149,"kind":2048,"name":"generateOAuthURL","url":"classes/oauthresource.html#generateoauthurl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuthResource"},{"id":1150,"kind":2048,"name":"getAccessToken","url":"classes/oauthresource.html#getaccesstoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuthResource"},{"id":1151,"kind":2048,"name":"refreshToken","url":"classes/oauthresource.html#refreshtoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuthResource"},{"id":1152,"kind":1024,"name":"httpService","url":"classes/oauthresource.html#httpservice","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"OAuthResource"},{"id":1153,"kind":1024,"name":"basePath","url":"classes/oauthresource.html#basepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"OAuthResource"},{"id":1154,"kind":128,"name":"UserResource","url":"classes/userresource.html","classes":"tsd-kind-class"},{"id":1155,"kind":1024,"name":"resourcePath","url":"classes/userresource.html#resourcepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"UserResource"},{"id":1156,"kind":512,"name":"constructor","url":"classes/userresource.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"UserResource"},{"id":1157,"kind":2048,"name":"getMembershipDataForCurrentUser","url":"classes/userresource.html#getmembershipdataforcurrentuser","classes":"tsd-kind-method tsd-parent-kind-class","parent":"UserResource"},{"id":1158,"kind":2048,"name":"getMembershipDataById","url":"classes/userresource.html#getmembershipdatabyid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"UserResource"},{"id":1159,"kind":1024,"name":"httpService","url":"classes/userresource.html#httpservice","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"UserResource"},{"id":1160,"kind":1024,"name":"basePath","url":"classes/userresource.html#basepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"UserResource"},{"id":1161,"kind":65536,"name":"__type","url":"interfaces/icontenttypedescription.html#tagmetadataitems.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IContentTypeDescription.tagMetadataItems"},{"id":1162,"kind":65536,"name":"__type","url":"interfaces/icontenttypeproperty.html#attributes.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IContentTypeProperty.attributes"},{"id":1163,"kind":65536,"name":"__type","url":"interfaces/icontenttypeproperty.html#representationselection.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IContentTypeProperty.representationSelection"},{"id":1164,"kind":65536,"name":"__type","url":"interfaces/icontentitempubliccontract.html#properties.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IContentItemPublicContract.properties"},{"id":1165,"kind":65536,"name":"__type","url":"interfaces/igroupresponse.html#currentusermembermap.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IGroupResponse.currentUserMemberMap"},{"id":1166,"kind":65536,"name":"__type","url":"interfaces/igroupresponse.html#currentuserpotentialmembermap.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IGroupResponse.currentUserPotentialMemberMap"},{"id":1167,"kind":65536,"name":"__type","url":"interfaces/igroupv2claninfoandinvestment.html#d2clanprogressions.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"IGroupV2ClanInfoAndInvestment.d2ClanProgressions"},{"id":1168,"kind":32,"name":"App","url":"globals.html#app","classes":"tsd-kind-variable"},{"id":1169,"kind":32,"name":"User","url":"globals.html#user","classes":"tsd-kind-variable"},{"id":1170,"kind":32,"name":"Content","url":"globals.html#content","classes":"tsd-kind-variable"},{"id":1171,"kind":32,"name":"Forum","url":"globals.html#forum","classes":"tsd-kind-variable"},{"id":1172,"kind":32,"name":"GroupV2","url":"globals.html#groupv2","classes":"tsd-kind-variable"},{"id":1173,"kind":32,"name":"Destiny2","url":"globals.html#destiny2","classes":"tsd-kind-variable"},{"id":1174,"kind":32,"name":"CommunityContent","url":"globals.html#communitycontent","classes":"tsd-kind-variable"},{"id":1175,"kind":32,"name":"Trending","url":"globals.html#trending","classes":"tsd-kind-variable"},{"id":1176,"kind":32,"name":"Fireteam","url":"globals.html#fireteam","classes":"tsd-kind-variable"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","32":"Variable","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal"},"rows":[{"id":0,"kind":128,"name":"BungieResource","url":"classes/bungieresource.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"httpService","url":"classes/bungieresource.html#httpservice","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"BungieResource"},{"id":2,"kind":1024,"name":"basePath","url":"classes/bungieresource.html#basepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"BungieResource"},{"id":3,"kind":1024,"name":"resourcePath","url":"classes/bungieresource.html#resourcepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"BungieResource"},{"id":4,"kind":512,"name":"constructor","url":"classes/bungieresource.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"BungieResource"},{"id":5,"kind":256,"name":"ServerResponse","url":"interfaces/serverresponse.html","classes":"tsd-kind-interface tsd-has-type-parameter"},{"id":6,"kind":1024,"name":"Response","url":"interfaces/serverresponse.html#response","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ServerResponse"},{"id":7,"kind":1024,"name":"ErrorCode","url":"interfaces/serverresponse.html#errorcode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ServerResponse"},{"id":8,"kind":1024,"name":"ThrottleSeconds","url":"interfaces/serverresponse.html#throttleseconds","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ServerResponse"},{"id":9,"kind":1024,"name":"ErrorStatus","url":"interfaces/serverresponse.html#errorstatus","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ServerResponse"},{"id":10,"kind":1024,"name":"Message","url":"interfaces/serverresponse.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ServerResponse"},{"id":11,"kind":1024,"name":"MessageData","url":"interfaces/serverresponse.html#messagedata","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ServerResponse"},{"id":12,"kind":65536,"name":"__type","url":"interfaces/serverresponse.html#messagedata.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"ServerResponse.MessageData"},{"id":13,"kind":256,"name":"DateRange","url":"interfaces/daterange.html","classes":"tsd-kind-interface"},{"id":14,"kind":1024,"name":"start","url":"interfaces/daterange.html#start","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DateRange"},{"id":15,"kind":1024,"name":"end","url":"interfaces/daterange.html#end","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DateRange"},{"id":16,"kind":4,"name":"PlatformErrorCodes","url":"enums/platformerrorcodes.html","classes":"tsd-kind-enum"},{"id":17,"kind":16,"name":"None","url":"enums/platformerrorcodes.html#none","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":18,"kind":16,"name":"Success","url":"enums/platformerrorcodes.html#success","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":19,"kind":16,"name":"TransportException","url":"enums/platformerrorcodes.html#transportexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":20,"kind":16,"name":"UnhandledException","url":"enums/platformerrorcodes.html#unhandledexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":21,"kind":16,"name":"NotImplemented","url":"enums/platformerrorcodes.html#notimplemented","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":22,"kind":16,"name":"SystemDisabled","url":"enums/platformerrorcodes.html#systemdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":23,"kind":16,"name":"FailedToLoadAvailableLocalesConfiguration","url":"enums/platformerrorcodes.html#failedtoloadavailablelocalesconfiguration","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":24,"kind":16,"name":"ParameterParseFailure","url":"enums/platformerrorcodes.html#parameterparsefailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":25,"kind":16,"name":"ParameterInvalidRange","url":"enums/platformerrorcodes.html#parameterinvalidrange","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":26,"kind":16,"name":"BadRequest","url":"enums/platformerrorcodes.html#badrequest","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":27,"kind":16,"name":"AuthenticationInvalid","url":"enums/platformerrorcodes.html#authenticationinvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":28,"kind":16,"name":"DataNotFound","url":"enums/platformerrorcodes.html#datanotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":29,"kind":16,"name":"InsufficientPrivileges","url":"enums/platformerrorcodes.html#insufficientprivileges","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":30,"kind":16,"name":"Duplicate","url":"enums/platformerrorcodes.html#duplicate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":31,"kind":16,"name":"UnknownSqlResult","url":"enums/platformerrorcodes.html#unknownsqlresult","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":32,"kind":16,"name":"ValidationError","url":"enums/platformerrorcodes.html#validationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":33,"kind":16,"name":"ValidationMissingFieldError","url":"enums/platformerrorcodes.html#validationmissingfielderror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":34,"kind":16,"name":"ValidationInvalidInputError","url":"enums/platformerrorcodes.html#validationinvalidinputerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":35,"kind":16,"name":"InvalidParameters","url":"enums/platformerrorcodes.html#invalidparameters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":36,"kind":16,"name":"ParameterNotFound","url":"enums/platformerrorcodes.html#parameternotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":37,"kind":16,"name":"UnhandledHttpException","url":"enums/platformerrorcodes.html#unhandledhttpexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":38,"kind":16,"name":"NotFound","url":"enums/platformerrorcodes.html#notfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":39,"kind":16,"name":"WebAuthModuleAsyncFailed","url":"enums/platformerrorcodes.html#webauthmoduleasyncfailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":40,"kind":16,"name":"InvalidReturnValue","url":"enums/platformerrorcodes.html#invalidreturnvalue","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":41,"kind":16,"name":"UserBanned","url":"enums/platformerrorcodes.html#userbanned","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":42,"kind":16,"name":"InvalidPostBody","url":"enums/platformerrorcodes.html#invalidpostbody","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":43,"kind":16,"name":"MissingPostBody","url":"enums/platformerrorcodes.html#missingpostbody","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":44,"kind":16,"name":"ExternalServiceTimeout","url":"enums/platformerrorcodes.html#externalservicetimeout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":45,"kind":16,"name":"ValidationLengthError","url":"enums/platformerrorcodes.html#validationlengtherror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":46,"kind":16,"name":"ValidationRangeError","url":"enums/platformerrorcodes.html#validationrangeerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":47,"kind":16,"name":"JsonDeserializationError","url":"enums/platformerrorcodes.html#jsondeserializationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":48,"kind":16,"name":"ThrottleLimitExceeded","url":"enums/platformerrorcodes.html#throttlelimitexceeded","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":49,"kind":16,"name":"ValidationTagError","url":"enums/platformerrorcodes.html#validationtagerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":50,"kind":16,"name":"ValidationProfanityError","url":"enums/platformerrorcodes.html#validationprofanityerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":51,"kind":16,"name":"ValidationUrlFormatError","url":"enums/platformerrorcodes.html#validationurlformaterror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":52,"kind":16,"name":"ThrottleLimitExceededMinutes","url":"enums/platformerrorcodes.html#throttlelimitexceededminutes","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":53,"kind":16,"name":"ThrottleLimitExceededMomentarily","url":"enums/platformerrorcodes.html#throttlelimitexceededmomentarily","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":54,"kind":16,"name":"ThrottleLimitExceededSeconds","url":"enums/platformerrorcodes.html#throttlelimitexceededseconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":55,"kind":16,"name":"ExternalServiceUnknown","url":"enums/platformerrorcodes.html#externalserviceunknown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":56,"kind":16,"name":"ValidationWordLengthError","url":"enums/platformerrorcodes.html#validationwordlengtherror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":57,"kind":16,"name":"ValidationInvisibleUnicode","url":"enums/platformerrorcodes.html#validationinvisibleunicode","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":58,"kind":16,"name":"ValidationBadNames","url":"enums/platformerrorcodes.html#validationbadnames","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":59,"kind":16,"name":"ExternalServiceFailed","url":"enums/platformerrorcodes.html#externalservicefailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":60,"kind":16,"name":"ServiceRetired","url":"enums/platformerrorcodes.html#serviceretired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":61,"kind":16,"name":"UnknownSqlException","url":"enums/platformerrorcodes.html#unknownsqlexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":62,"kind":16,"name":"UnsupportedLocale","url":"enums/platformerrorcodes.html#unsupportedlocale","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":63,"kind":16,"name":"InvalidPageNumber","url":"enums/platformerrorcodes.html#invalidpagenumber","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":64,"kind":16,"name":"MaximumPageSizeExceeded","url":"enums/platformerrorcodes.html#maximumpagesizeexceeded","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":65,"kind":16,"name":"ServiceUnsupported","url":"enums/platformerrorcodes.html#serviceunsupported","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":66,"kind":16,"name":"ValidationMaximumUnicodeCombiningCharacters","url":"enums/platformerrorcodes.html#validationmaximumunicodecombiningcharacters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":67,"kind":16,"name":"ValidationMaximumSequentialCarriageReturns","url":"enums/platformerrorcodes.html#validationmaximumsequentialcarriagereturns","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":68,"kind":16,"name":"PerEndpointRequestThrottleExceeded","url":"enums/platformerrorcodes.html#perendpointrequestthrottleexceeded","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":69,"kind":16,"name":"AuthContextCacheAssertion","url":"enums/platformerrorcodes.html#authcontextcacheassertion","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":70,"kind":16,"name":"ExPlatformStringValidationError","url":"enums/platformerrorcodes.html#explatformstringvalidationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":71,"kind":16,"name":"ObsoleteCredentialType","url":"enums/platformerrorcodes.html#obsoletecredentialtype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":72,"kind":16,"name":"UnableToUnPairMobileApp","url":"enums/platformerrorcodes.html#unabletounpairmobileapp","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":73,"kind":16,"name":"UnableToPairMobileApp","url":"enums/platformerrorcodes.html#unabletopairmobileapp","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":74,"kind":16,"name":"CannotUseMobileAuthWithNonMobileProvider","url":"enums/platformerrorcodes.html#cannotusemobileauthwithnonmobileprovider","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":75,"kind":16,"name":"MissingDeviceCookie","url":"enums/platformerrorcodes.html#missingdevicecookie","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":76,"kind":16,"name":"FacebookTokenExpired","url":"enums/platformerrorcodes.html#facebooktokenexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":77,"kind":16,"name":"AuthTicketRequired","url":"enums/platformerrorcodes.html#authticketrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":78,"kind":16,"name":"CookieContextRequired","url":"enums/platformerrorcodes.html#cookiecontextrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":79,"kind":16,"name":"UnknownAuthenticationError","url":"enums/platformerrorcodes.html#unknownauthenticationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":80,"kind":16,"name":"BungieNetAccountCreationRequired","url":"enums/platformerrorcodes.html#bungienetaccountcreationrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":81,"kind":16,"name":"WebAuthRequired","url":"enums/platformerrorcodes.html#webauthrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":82,"kind":16,"name":"ContentUnknownSqlResult","url":"enums/platformerrorcodes.html#contentunknownsqlresult","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":83,"kind":16,"name":"ContentNeedUniquePath","url":"enums/platformerrorcodes.html#contentneeduniquepath","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":84,"kind":16,"name":"ContentSqlException","url":"enums/platformerrorcodes.html#contentsqlexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":85,"kind":16,"name":"ContentNotFound","url":"enums/platformerrorcodes.html#contentnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":86,"kind":16,"name":"ContentSuccessWithTagAddFail","url":"enums/platformerrorcodes.html#contentsuccesswithtagaddfail","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":87,"kind":16,"name":"ContentSearchMissingParameters","url":"enums/platformerrorcodes.html#contentsearchmissingparameters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":88,"kind":16,"name":"ContentInvalidId","url":"enums/platformerrorcodes.html#contentinvalidid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":89,"kind":16,"name":"ContentPhysicalFileDeletionError","url":"enums/platformerrorcodes.html#contentphysicalfiledeletionerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":90,"kind":16,"name":"ContentPhysicalFileCreationError","url":"enums/platformerrorcodes.html#contentphysicalfilecreationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":91,"kind":16,"name":"ContentPerforceSubmissionError","url":"enums/platformerrorcodes.html#contentperforcesubmissionerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":92,"kind":16,"name":"ContentPerforceInitializationError","url":"enums/platformerrorcodes.html#contentperforceinitializationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":93,"kind":16,"name":"ContentDeploymentPackageNotReadyError","url":"enums/platformerrorcodes.html#contentdeploymentpackagenotreadyerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":94,"kind":16,"name":"ContentUploadFailed","url":"enums/platformerrorcodes.html#contentuploadfailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":95,"kind":16,"name":"ContentTooManyResults","url":"enums/platformerrorcodes.html#contenttoomanyresults","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":96,"kind":16,"name":"ContentInvalidState","url":"enums/platformerrorcodes.html#contentinvalidstate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":97,"kind":16,"name":"ContentNavigationParentNotFound","url":"enums/platformerrorcodes.html#contentnavigationparentnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":98,"kind":16,"name":"ContentNavigationParentUpdateError","url":"enums/platformerrorcodes.html#contentnavigationparentupdateerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":99,"kind":16,"name":"DeploymentPackageNotEditable","url":"enums/platformerrorcodes.html#deploymentpackagenoteditable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":100,"kind":16,"name":"ContentValidationError","url":"enums/platformerrorcodes.html#contentvalidationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":101,"kind":16,"name":"ContentPropertiesValidationError","url":"enums/platformerrorcodes.html#contentpropertiesvalidationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":102,"kind":16,"name":"ContentTypeNotFound","url":"enums/platformerrorcodes.html#contenttypenotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":103,"kind":16,"name":"DeploymentPackageNotFound","url":"enums/platformerrorcodes.html#deploymentpackagenotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":104,"kind":16,"name":"ContentSearchInvalidParameters","url":"enums/platformerrorcodes.html#contentsearchinvalidparameters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":105,"kind":16,"name":"ContentItemPropertyAggregationError","url":"enums/platformerrorcodes.html#contentitempropertyaggregationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":106,"kind":16,"name":"DeploymentPackageFileNotFound","url":"enums/platformerrorcodes.html#deploymentpackagefilenotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":107,"kind":16,"name":"ContentPerforceFileHistoryNotFound","url":"enums/platformerrorcodes.html#contentperforcefilehistorynotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":108,"kind":16,"name":"ContentAssetZipCreationFailure","url":"enums/platformerrorcodes.html#contentassetzipcreationfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":109,"kind":16,"name":"ContentAssetZipCreationBusy","url":"enums/platformerrorcodes.html#contentassetzipcreationbusy","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":110,"kind":16,"name":"ContentProjectNotFound","url":"enums/platformerrorcodes.html#contentprojectnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":111,"kind":16,"name":"ContentFolderNotFound","url":"enums/platformerrorcodes.html#contentfoldernotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":112,"kind":16,"name":"ContentPackagesInconsistent","url":"enums/platformerrorcodes.html#contentpackagesinconsistent","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":113,"kind":16,"name":"ContentPackagesInvalidState","url":"enums/platformerrorcodes.html#contentpackagesinvalidstate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":114,"kind":16,"name":"ContentPackagesInconsistentType","url":"enums/platformerrorcodes.html#contentpackagesinconsistenttype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":115,"kind":16,"name":"ContentCannotDeletePackage","url":"enums/platformerrorcodes.html#contentcannotdeletepackage","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":116,"kind":16,"name":"ContentLockedForChanges","url":"enums/platformerrorcodes.html#contentlockedforchanges","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":117,"kind":16,"name":"ContentFileUploadFailed","url":"enums/platformerrorcodes.html#contentfileuploadfailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":118,"kind":16,"name":"ContentNotReviewed","url":"enums/platformerrorcodes.html#contentnotreviewed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":119,"kind":16,"name":"ContentPermissionDenied","url":"enums/platformerrorcodes.html#contentpermissiondenied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":120,"kind":16,"name":"ContentInvalidExternalUrl","url":"enums/platformerrorcodes.html#contentinvalidexternalurl","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":121,"kind":16,"name":"ContentExternalFileCannotBeImportedLocally","url":"enums/platformerrorcodes.html#contentexternalfilecannotbeimportedlocally","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":122,"kind":16,"name":"ContentTagSaveFailure","url":"enums/platformerrorcodes.html#contenttagsavefailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":123,"kind":16,"name":"ContentPerforceUnmatchedFileError","url":"enums/platformerrorcodes.html#contentperforceunmatchedfileerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":124,"kind":16,"name":"ContentPerforceChangelistResultNotFound","url":"enums/platformerrorcodes.html#contentperforcechangelistresultnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":125,"kind":16,"name":"ContentPerforceChangelistFileItemsNotFound","url":"enums/platformerrorcodes.html#contentperforcechangelistfileitemsnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":126,"kind":16,"name":"ContentPerforceInvalidRevisionError","url":"enums/platformerrorcodes.html#contentperforceinvalidrevisionerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":127,"kind":16,"name":"ContentUnloadedSaveResult","url":"enums/platformerrorcodes.html#contentunloadedsaveresult","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":128,"kind":16,"name":"ContentPropertyInvalidNumber","url":"enums/platformerrorcodes.html#contentpropertyinvalidnumber","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":129,"kind":16,"name":"ContentPropertyInvalidUrl","url":"enums/platformerrorcodes.html#contentpropertyinvalidurl","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":130,"kind":16,"name":"ContentPropertyInvalidDate","url":"enums/platformerrorcodes.html#contentpropertyinvaliddate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":131,"kind":16,"name":"ContentPropertyInvalidSet","url":"enums/platformerrorcodes.html#contentpropertyinvalidset","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":132,"kind":16,"name":"ContentPropertyCannotDeserialize","url":"enums/platformerrorcodes.html#contentpropertycannotdeserialize","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":133,"kind":16,"name":"ContentRegexValidationFailOnProperty","url":"enums/platformerrorcodes.html#contentregexvalidationfailonproperty","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":134,"kind":16,"name":"ContentMaxLengthFailOnProperty","url":"enums/platformerrorcodes.html#contentmaxlengthfailonproperty","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":135,"kind":16,"name":"ContentPropertyUnexpectedDeserializationError","url":"enums/platformerrorcodes.html#contentpropertyunexpecteddeserializationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":136,"kind":16,"name":"ContentPropertyRequired","url":"enums/platformerrorcodes.html#contentpropertyrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":137,"kind":16,"name":"ContentCannotCreateFile","url":"enums/platformerrorcodes.html#contentcannotcreatefile","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":138,"kind":16,"name":"ContentInvalidMigrationFile","url":"enums/platformerrorcodes.html#contentinvalidmigrationfile","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":139,"kind":16,"name":"ContentMigrationAlteringProcessedItem","url":"enums/platformerrorcodes.html#contentmigrationalteringprocesseditem","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":140,"kind":16,"name":"ContentPropertyDefinitionNotFound","url":"enums/platformerrorcodes.html#contentpropertydefinitionnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":141,"kind":16,"name":"ContentReviewDataChanged","url":"enums/platformerrorcodes.html#contentreviewdatachanged","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":142,"kind":16,"name":"ContentRollbackRevisionNotInPackage","url":"enums/platformerrorcodes.html#contentrollbackrevisionnotinpackage","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":143,"kind":16,"name":"ContentItemNotBasedOnLatestRevision","url":"enums/platformerrorcodes.html#contentitemnotbasedonlatestrevision","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":144,"kind":16,"name":"ContentUnauthorized","url":"enums/platformerrorcodes.html#contentunauthorized","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":145,"kind":16,"name":"ContentCannotCreateDeploymentPackage","url":"enums/platformerrorcodes.html#contentcannotcreatedeploymentpackage","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":146,"kind":16,"name":"ContentUserNotFound","url":"enums/platformerrorcodes.html#contentusernotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":147,"kind":16,"name":"ContentLocalePermissionDenied","url":"enums/platformerrorcodes.html#contentlocalepermissiondenied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":148,"kind":16,"name":"ContentInvalidLinkToInternalEnvironment","url":"enums/platformerrorcodes.html#contentinvalidlinktointernalenvironment","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":149,"kind":16,"name":"ContentInvalidBlacklistedContent","url":"enums/platformerrorcodes.html#contentinvalidblacklistedcontent","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":150,"kind":16,"name":"ContentMacroMalformedNoContentId","url":"enums/platformerrorcodes.html#contentmacromalformednocontentid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":151,"kind":16,"name":"ContentMacroMalformedNoTemplateType","url":"enums/platformerrorcodes.html#contentmacromalformednotemplatetype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":152,"kind":16,"name":"ContentIllegalBNetMembershipId","url":"enums/platformerrorcodes.html#contentillegalbnetmembershipid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":153,"kind":16,"name":"ContentLocaleDidNotMatchExpected","url":"enums/platformerrorcodes.html#contentlocaledidnotmatchexpected","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":154,"kind":16,"name":"ContentBabelCallFailed","url":"enums/platformerrorcodes.html#contentbabelcallfailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":155,"kind":16,"name":"ContentEnglishPostLiveForbidden","url":"enums/platformerrorcodes.html#contentenglishpostliveforbidden","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":156,"kind":16,"name":"ContentLocaleEditPermissionDenied","url":"enums/platformerrorcodes.html#contentlocaleeditpermissiondenied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":157,"kind":16,"name":"UserNonUniqueName","url":"enums/platformerrorcodes.html#usernonuniquename","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":158,"kind":16,"name":"UserManualLinkingStepRequired","url":"enums/platformerrorcodes.html#usermanuallinkingsteprequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":159,"kind":16,"name":"UserCreateUnknownSqlResult","url":"enums/platformerrorcodes.html#usercreateunknownsqlresult","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":160,"kind":16,"name":"UserCreateUnknownSqlException","url":"enums/platformerrorcodes.html#usercreateunknownsqlexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":161,"kind":16,"name":"UserMalformedMembershipId","url":"enums/platformerrorcodes.html#usermalformedmembershipid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":162,"kind":16,"name":"UserCannotFindRequestedUser","url":"enums/platformerrorcodes.html#usercannotfindrequesteduser","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":163,"kind":16,"name":"UserCannotLoadAccountCredentialLinkInfo","url":"enums/platformerrorcodes.html#usercannotloadaccountcredentiallinkinfo","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":164,"kind":16,"name":"UserInvalidMobileAppType","url":"enums/platformerrorcodes.html#userinvalidmobileapptype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":165,"kind":16,"name":"UserMissingMobilePairingInfo","url":"enums/platformerrorcodes.html#usermissingmobilepairinginfo","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":166,"kind":16,"name":"UserCannotGenerateMobileKeyWhileUsingMobileCredential","url":"enums/platformerrorcodes.html#usercannotgeneratemobilekeywhileusingmobilecredential","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":167,"kind":16,"name":"UserGenerateMobileKeyExistingSlotCollision","url":"enums/platformerrorcodes.html#usergeneratemobilekeyexistingslotcollision","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":168,"kind":16,"name":"UserDisplayNameMissingOrInvalid","url":"enums/platformerrorcodes.html#userdisplaynamemissingorinvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":169,"kind":16,"name":"UserCannotLoadAccountProfileData","url":"enums/platformerrorcodes.html#usercannotloadaccountprofiledata","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":170,"kind":16,"name":"UserCannotSaveUserProfileData","url":"enums/platformerrorcodes.html#usercannotsaveuserprofiledata","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":171,"kind":16,"name":"UserEmailMissingOrInvalid","url":"enums/platformerrorcodes.html#useremailmissingorinvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":172,"kind":16,"name":"UserTermsOfUseRequired","url":"enums/platformerrorcodes.html#usertermsofuserequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":173,"kind":16,"name":"UserCannotCreateNewAccountWhileLoggedIn","url":"enums/platformerrorcodes.html#usercannotcreatenewaccountwhileloggedin","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":174,"kind":16,"name":"UserCannotResolveCentralAccount","url":"enums/platformerrorcodes.html#usercannotresolvecentralaccount","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":175,"kind":16,"name":"UserInvalidAvatar","url":"enums/platformerrorcodes.html#userinvalidavatar","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":176,"kind":16,"name":"UserMissingCreatedUserResult","url":"enums/platformerrorcodes.html#usermissingcreateduserresult","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":177,"kind":16,"name":"UserCannotChangeUniqueNameYet","url":"enums/platformerrorcodes.html#usercannotchangeuniquenameyet","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":178,"kind":16,"name":"UserCannotChangeDisplayNameYet","url":"enums/platformerrorcodes.html#usercannotchangedisplaynameyet","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":179,"kind":16,"name":"UserCannotChangeEmail","url":"enums/platformerrorcodes.html#usercannotchangeemail","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":180,"kind":16,"name":"UserUniqueNameMustStartWithLetter","url":"enums/platformerrorcodes.html#useruniquenamemuststartwithletter","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":181,"kind":16,"name":"UserNoLinkedAccountsSupportFriendListings","url":"enums/platformerrorcodes.html#usernolinkedaccountssupportfriendlistings","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":182,"kind":16,"name":"UserAcknowledgmentTableFull","url":"enums/platformerrorcodes.html#useracknowledgmenttablefull","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":183,"kind":16,"name":"UserCreationDestinyMembershipRequired","url":"enums/platformerrorcodes.html#usercreationdestinymembershiprequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":184,"kind":16,"name":"UserFriendsTokenNeedsRefresh","url":"enums/platformerrorcodes.html#userfriendstokenneedsrefresh","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":185,"kind":16,"name":"UserEmailValidationUnknown","url":"enums/platformerrorcodes.html#useremailvalidationunknown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":186,"kind":16,"name":"UserEmailValidationLimit","url":"enums/platformerrorcodes.html#useremailvalidationlimit","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":187,"kind":16,"name":"TransactionEmailSendFailure","url":"enums/platformerrorcodes.html#transactionemailsendfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":188,"kind":16,"name":"MessagingUnknownError","url":"enums/platformerrorcodes.html#messagingunknownerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":189,"kind":16,"name":"MessagingSelfError","url":"enums/platformerrorcodes.html#messagingselferror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":190,"kind":16,"name":"MessagingSendThrottle","url":"enums/platformerrorcodes.html#messagingsendthrottle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":191,"kind":16,"name":"MessagingNoBody","url":"enums/platformerrorcodes.html#messagingnobody","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":192,"kind":16,"name":"MessagingTooManyUsers","url":"enums/platformerrorcodes.html#messagingtoomanyusers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":193,"kind":16,"name":"MessagingCanNotLeaveConversation","url":"enums/platformerrorcodes.html#messagingcannotleaveconversation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":194,"kind":16,"name":"MessagingUnableToSend","url":"enums/platformerrorcodes.html#messagingunabletosend","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":195,"kind":16,"name":"MessagingDeletedUserForbidden","url":"enums/platformerrorcodes.html#messagingdeleteduserforbidden","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":196,"kind":16,"name":"MessagingCannotDeleteExternalConversation","url":"enums/platformerrorcodes.html#messagingcannotdeleteexternalconversation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":197,"kind":16,"name":"MessagingGroupChatDisabled","url":"enums/platformerrorcodes.html#messaginggroupchatdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":198,"kind":16,"name":"MessagingMustIncludeSelfInPrivateMessage","url":"enums/platformerrorcodes.html#messagingmustincludeselfinprivatemessage","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":199,"kind":16,"name":"MessagingSenderIsBanned","url":"enums/platformerrorcodes.html#messagingsenderisbanned","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":200,"kind":16,"name":"MessagingGroupOptionalChatExceededMaximum","url":"enums/platformerrorcodes.html#messaginggroupoptionalchatexceededmaximum","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":201,"kind":16,"name":"PrivateMessagingRequiresDestinyMembership","url":"enums/platformerrorcodes.html#privatemessagingrequiresdestinymembership","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":202,"kind":16,"name":"AddSurveyAnswersUnknownSqlException","url":"enums/platformerrorcodes.html#addsurveyanswersunknownsqlexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":203,"kind":16,"name":"ForumBodyCannotBeEmpty","url":"enums/platformerrorcodes.html#forumbodycannotbeempty","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":204,"kind":16,"name":"ForumSubjectCannotBeEmptyOnTopicPost","url":"enums/platformerrorcodes.html#forumsubjectcannotbeemptyontopicpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":205,"kind":16,"name":"ForumCannotLocateParentPost","url":"enums/platformerrorcodes.html#forumcannotlocateparentpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":206,"kind":16,"name":"ForumThreadLockedForReplies","url":"enums/platformerrorcodes.html#forumthreadlockedforreplies","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":207,"kind":16,"name":"ForumUnknownSqlResultDuringCreatePost","url":"enums/platformerrorcodes.html#forumunknownsqlresultduringcreatepost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":208,"kind":16,"name":"ForumUnknownTagCreationError","url":"enums/platformerrorcodes.html#forumunknowntagcreationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":209,"kind":16,"name":"ForumUnknownSqlResultDuringTagItem","url":"enums/platformerrorcodes.html#forumunknownsqlresultduringtagitem","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":210,"kind":16,"name":"ForumUnknownExceptionCreatePost","url":"enums/platformerrorcodes.html#forumunknownexceptioncreatepost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":211,"kind":16,"name":"ForumQuestionMustBeTopicPost","url":"enums/platformerrorcodes.html#forumquestionmustbetopicpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":212,"kind":16,"name":"ForumExceptionDuringTagSearch","url":"enums/platformerrorcodes.html#forumexceptionduringtagsearch","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":213,"kind":16,"name":"ForumExceptionDuringTopicRetrieval","url":"enums/platformerrorcodes.html#forumexceptionduringtopicretrieval","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":214,"kind":16,"name":"ForumAliasedTagError","url":"enums/platformerrorcodes.html#forumaliasedtagerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":215,"kind":16,"name":"ForumCannotLocateThread","url":"enums/platformerrorcodes.html#forumcannotlocatethread","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":216,"kind":16,"name":"ForumUnknownExceptionEditPost","url":"enums/platformerrorcodes.html#forumunknownexceptioneditpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":217,"kind":16,"name":"ForumCannotLocatePost","url":"enums/platformerrorcodes.html#forumcannotlocatepost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":218,"kind":16,"name":"ForumUnknownExceptionGetOrCreateTags","url":"enums/platformerrorcodes.html#forumunknownexceptiongetorcreatetags","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":219,"kind":16,"name":"ForumEditPermissionDenied","url":"enums/platformerrorcodes.html#forumeditpermissiondenied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":220,"kind":16,"name":"ForumUnknownSqlResultDuringTagIdRetrieval","url":"enums/platformerrorcodes.html#forumunknownsqlresultduringtagidretrieval","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":221,"kind":16,"name":"ForumCannotGetRating","url":"enums/platformerrorcodes.html#forumcannotgetrating","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":222,"kind":16,"name":"ForumUnknownExceptionGetRating","url":"enums/platformerrorcodes.html#forumunknownexceptiongetrating","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":223,"kind":16,"name":"ForumRatingsAccessError","url":"enums/platformerrorcodes.html#forumratingsaccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":224,"kind":16,"name":"ForumRelatedPostAccessError","url":"enums/platformerrorcodes.html#forumrelatedpostaccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":225,"kind":16,"name":"ForumLatestReplyAccessError","url":"enums/platformerrorcodes.html#forumlatestreplyaccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":226,"kind":16,"name":"ForumUserStatusAccessError","url":"enums/platformerrorcodes.html#forumuserstatusaccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":227,"kind":16,"name":"ForumAuthorAccessError","url":"enums/platformerrorcodes.html#forumauthoraccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":228,"kind":16,"name":"ForumGroupAccessError","url":"enums/platformerrorcodes.html#forumgroupaccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":229,"kind":16,"name":"ForumUrlExpectedButMissing","url":"enums/platformerrorcodes.html#forumurlexpectedbutmissing","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":230,"kind":16,"name":"ForumRepliesCannotBeEmpty","url":"enums/platformerrorcodes.html#forumrepliescannotbeempty","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":231,"kind":16,"name":"ForumRepliesCannotBeInDifferentGroups","url":"enums/platformerrorcodes.html#forumrepliescannotbeindifferentgroups","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":232,"kind":16,"name":"ForumSubTopicCannotBeCreatedAtThisThreadLevel","url":"enums/platformerrorcodes.html#forumsubtopiccannotbecreatedatthisthreadlevel","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":233,"kind":16,"name":"ForumCannotCreateContentTopic","url":"enums/platformerrorcodes.html#forumcannotcreatecontenttopic","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":234,"kind":16,"name":"ForumTopicDoesNotExist","url":"enums/platformerrorcodes.html#forumtopicdoesnotexist","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":235,"kind":16,"name":"ForumContentCommentsNotAllowed","url":"enums/platformerrorcodes.html#forumcontentcommentsnotallowed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":236,"kind":16,"name":"ForumUnknownSqlResultDuringEditPost","url":"enums/platformerrorcodes.html#forumunknownsqlresultduringeditpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":237,"kind":16,"name":"ForumUnknownSqlResultDuringGetPost","url":"enums/platformerrorcodes.html#forumunknownsqlresultduringgetpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":238,"kind":16,"name":"ForumPostValidationBadUrl","url":"enums/platformerrorcodes.html#forumpostvalidationbadurl","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":239,"kind":16,"name":"ForumBodyTooLong","url":"enums/platformerrorcodes.html#forumbodytoolong","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":240,"kind":16,"name":"ForumSubjectTooLong","url":"enums/platformerrorcodes.html#forumsubjecttoolong","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":241,"kind":16,"name":"ForumAnnouncementNotAllowed","url":"enums/platformerrorcodes.html#forumannouncementnotallowed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":242,"kind":16,"name":"ForumCannotShareOwnPost","url":"enums/platformerrorcodes.html#forumcannotshareownpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":243,"kind":16,"name":"ForumEditNoOp","url":"enums/platformerrorcodes.html#forumeditnoop","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":244,"kind":16,"name":"ForumUnknownDatabaseErrorDuringGetPost","url":"enums/platformerrorcodes.html#forumunknowndatabaseerrorduringgetpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":245,"kind":16,"name":"ForumExceeedMaximumRowLimit","url":"enums/platformerrorcodes.html#forumexceeedmaximumrowlimit","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":246,"kind":16,"name":"ForumCannotSharePrivatePost","url":"enums/platformerrorcodes.html#forumcannotshareprivatepost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":247,"kind":16,"name":"ForumCannotCrossPostBetweenGroups","url":"enums/platformerrorcodes.html#forumcannotcrosspostbetweengroups","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":248,"kind":16,"name":"ForumIncompatibleCategories","url":"enums/platformerrorcodes.html#forumincompatiblecategories","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":249,"kind":16,"name":"ForumCannotUseTheseCategoriesOnNonTopicPost","url":"enums/platformerrorcodes.html#forumcannotusethesecategoriesonnontopicpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":250,"kind":16,"name":"ForumCanOnlyDeleteTopics","url":"enums/platformerrorcodes.html#forumcanonlydeletetopics","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":251,"kind":16,"name":"ForumDeleteSqlException","url":"enums/platformerrorcodes.html#forumdeletesqlexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":252,"kind":16,"name":"ForumDeleteSqlUnknownResult","url":"enums/platformerrorcodes.html#forumdeletesqlunknownresult","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":253,"kind":16,"name":"ForumTooManyTags","url":"enums/platformerrorcodes.html#forumtoomanytags","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":254,"kind":16,"name":"ForumCanOnlyRateTopics","url":"enums/platformerrorcodes.html#forumcanonlyratetopics","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":255,"kind":16,"name":"ForumBannedPostsCannotBeEdited","url":"enums/platformerrorcodes.html#forumbannedpostscannotbeedited","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":256,"kind":16,"name":"ForumThreadRootIsBanned","url":"enums/platformerrorcodes.html#forumthreadrootisbanned","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":257,"kind":16,"name":"ForumCannotUseOfficialTagCategoryAsTag","url":"enums/platformerrorcodes.html#forumcannotuseofficialtagcategoryastag","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":258,"kind":16,"name":"ForumAnswerCannotBeMadeOnCreatePost","url":"enums/platformerrorcodes.html#forumanswercannotbemadeoncreatepost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":259,"kind":16,"name":"ForumAnswerCannotBeMadeOnEditPost","url":"enums/platformerrorcodes.html#forumanswercannotbemadeoneditpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":260,"kind":16,"name":"ForumAnswerPostIdIsNotADirectReplyOfQuestion","url":"enums/platformerrorcodes.html#forumanswerpostidisnotadirectreplyofquestion","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":261,"kind":16,"name":"ForumAnswerTopicIdIsNotAQuestion","url":"enums/platformerrorcodes.html#forumanswertopicidisnotaquestion","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":262,"kind":16,"name":"ForumUnknownExceptionDuringMarkAnswer","url":"enums/platformerrorcodes.html#forumunknownexceptionduringmarkanswer","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":263,"kind":16,"name":"ForumUnknownSqlResultDuringMarkAnswer","url":"enums/platformerrorcodes.html#forumunknownsqlresultduringmarkanswer","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":264,"kind":16,"name":"ForumCannotRateYourOwnPosts","url":"enums/platformerrorcodes.html#forumcannotrateyourownposts","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":265,"kind":16,"name":"ForumPollsMustBeTheFirstPostInTopic","url":"enums/platformerrorcodes.html#forumpollsmustbethefirstpostintopic","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":266,"kind":16,"name":"ForumInvalidPollInput","url":"enums/platformerrorcodes.html#foruminvalidpollinput","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":267,"kind":16,"name":"ForumGroupAdminEditNonMember","url":"enums/platformerrorcodes.html#forumgroupadmineditnonmember","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":268,"kind":16,"name":"ForumCannotEditModeratorEditedPost","url":"enums/platformerrorcodes.html#forumcannoteditmoderatoreditedpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":269,"kind":16,"name":"ForumRequiresDestinyMembership","url":"enums/platformerrorcodes.html#forumrequiresdestinymembership","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":270,"kind":16,"name":"ForumUnexpectedError","url":"enums/platformerrorcodes.html#forumunexpectederror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":271,"kind":16,"name":"ForumAgeLock","url":"enums/platformerrorcodes.html#forumagelock","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":272,"kind":16,"name":"ForumMaxPages","url":"enums/platformerrorcodes.html#forummaxpages","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":273,"kind":16,"name":"ForumMaxPagesOldestFirst","url":"enums/platformerrorcodes.html#forummaxpagesoldestfirst","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":274,"kind":16,"name":"ForumCannotApplyForumIdWithoutTags","url":"enums/platformerrorcodes.html#forumcannotapplyforumidwithouttags","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":275,"kind":16,"name":"ForumCannotApplyForumIdToNonTopics","url":"enums/platformerrorcodes.html#forumcannotapplyforumidtonontopics","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":276,"kind":16,"name":"ForumCannotDownvoteCommunityCreations","url":"enums/platformerrorcodes.html#forumcannotdownvotecommunitycreations","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":277,"kind":16,"name":"ForumTopicsMustHaveOfficialCategory","url":"enums/platformerrorcodes.html#forumtopicsmusthaveofficialcategory","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":278,"kind":16,"name":"ForumRecruitmentTopicMalformed","url":"enums/platformerrorcodes.html#forumrecruitmenttopicmalformed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":279,"kind":16,"name":"ForumRecruitmentTopicNotFound","url":"enums/platformerrorcodes.html#forumrecruitmenttopicnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":280,"kind":16,"name":"ForumRecruitmentTopicNoSlotsRemaining","url":"enums/platformerrorcodes.html#forumrecruitmenttopicnoslotsremaining","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":281,"kind":16,"name":"ForumRecruitmentTopicKickBan","url":"enums/platformerrorcodes.html#forumrecruitmenttopickickban","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":282,"kind":16,"name":"ForumRecruitmentTopicRequirementsNotMet","url":"enums/platformerrorcodes.html#forumrecruitmenttopicrequirementsnotmet","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":283,"kind":16,"name":"ForumRecruitmentTopicNoPlayers","url":"enums/platformerrorcodes.html#forumrecruitmenttopicnoplayers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":284,"kind":16,"name":"ForumRecruitmentApproveFailMessageBan","url":"enums/platformerrorcodes.html#forumrecruitmentapprovefailmessageban","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":285,"kind":16,"name":"ForumRecruitmentGlobalBan","url":"enums/platformerrorcodes.html#forumrecruitmentglobalban","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":286,"kind":16,"name":"ForumUserBannedFromThisTopic","url":"enums/platformerrorcodes.html#forumuserbannedfromthistopic","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":287,"kind":16,"name":"ForumRecruitmentFireteamMembersOnly","url":"enums/platformerrorcodes.html#forumrecruitmentfireteammembersonly","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":288,"kind":16,"name":"ForumRequiresDestiny2Progress","url":"enums/platformerrorcodes.html#forumrequiresdestiny2progress","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":289,"kind":16,"name":"GroupMembershipApplicationAlreadyResolved","url":"enums/platformerrorcodes.html#groupmembershipapplicationalreadyresolved","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":290,"kind":16,"name":"GroupMembershipAlreadyApplied","url":"enums/platformerrorcodes.html#groupmembershipalreadyapplied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":291,"kind":16,"name":"GroupMembershipInsufficientPrivileges","url":"enums/platformerrorcodes.html#groupmembershipinsufficientprivileges","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":292,"kind":16,"name":"GroupIdNotReturnedFromCreation","url":"enums/platformerrorcodes.html#groupidnotreturnedfromcreation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":293,"kind":16,"name":"GroupSearchInvalidParameters","url":"enums/platformerrorcodes.html#groupsearchinvalidparameters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":294,"kind":16,"name":"GroupMembershipPendingApplicationNotFound","url":"enums/platformerrorcodes.html#groupmembershippendingapplicationnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":295,"kind":16,"name":"GroupInvalidId","url":"enums/platformerrorcodes.html#groupinvalidid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":296,"kind":16,"name":"GroupInvalidMembershipId","url":"enums/platformerrorcodes.html#groupinvalidmembershipid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":297,"kind":16,"name":"GroupInvalidMembershipType","url":"enums/platformerrorcodes.html#groupinvalidmembershiptype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":298,"kind":16,"name":"GroupMissingTags","url":"enums/platformerrorcodes.html#groupmissingtags","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":299,"kind":16,"name":"GroupMembershipNotFound","url":"enums/platformerrorcodes.html#groupmembershipnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":300,"kind":16,"name":"GroupInvalidRating","url":"enums/platformerrorcodes.html#groupinvalidrating","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":301,"kind":16,"name":"GroupUserFollowingAccessError","url":"enums/platformerrorcodes.html#groupuserfollowingaccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":302,"kind":16,"name":"GroupUserMembershipAccessError","url":"enums/platformerrorcodes.html#groupusermembershipaccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":303,"kind":16,"name":"GroupCreatorAccessError","url":"enums/platformerrorcodes.html#groupcreatoraccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":304,"kind":16,"name":"GroupAdminAccessError","url":"enums/platformerrorcodes.html#groupadminaccesserror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":305,"kind":16,"name":"GroupPrivatePostNotViewable","url":"enums/platformerrorcodes.html#groupprivatepostnotviewable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":306,"kind":16,"name":"GroupMembershipNotLoggedIn","url":"enums/platformerrorcodes.html#groupmembershipnotloggedin","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":307,"kind":16,"name":"GroupNotDeleted","url":"enums/platformerrorcodes.html#groupnotdeleted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":308,"kind":16,"name":"GroupUnknownErrorUndeletingGroup","url":"enums/platformerrorcodes.html#groupunknownerrorundeletinggroup","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":309,"kind":16,"name":"GroupDeleted","url":"enums/platformerrorcodes.html#groupdeleted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":310,"kind":16,"name":"GroupNotFound","url":"enums/platformerrorcodes.html#groupnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":311,"kind":16,"name":"GroupMemberBanned","url":"enums/platformerrorcodes.html#groupmemberbanned","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":312,"kind":16,"name":"GroupMembershipClosed","url":"enums/platformerrorcodes.html#groupmembershipclosed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":313,"kind":16,"name":"GroupPrivatePostOverrideError","url":"enums/platformerrorcodes.html#groupprivatepostoverrideerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":314,"kind":16,"name":"GroupNameTaken","url":"enums/platformerrorcodes.html#groupnametaken","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":315,"kind":16,"name":"GroupDeletionGracePeriodExpired","url":"enums/platformerrorcodes.html#groupdeletiongraceperiodexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":316,"kind":16,"name":"GroupCannotCheckBanStatus","url":"enums/platformerrorcodes.html#groupcannotcheckbanstatus","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":317,"kind":16,"name":"GroupMaximumMembershipCountReached","url":"enums/platformerrorcodes.html#groupmaximummembershipcountreached","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":318,"kind":16,"name":"NoDestinyAccountForClanPlatform","url":"enums/platformerrorcodes.html#nodestinyaccountforclanplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":319,"kind":16,"name":"AlreadyRequestingMembershipForClanPlatform","url":"enums/platformerrorcodes.html#alreadyrequestingmembershipforclanplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":320,"kind":16,"name":"AlreadyClanMemberOnPlatform","url":"enums/platformerrorcodes.html#alreadyclanmemberonplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":321,"kind":16,"name":"GroupJoinedCannotSetClanName","url":"enums/platformerrorcodes.html#groupjoinedcannotsetclanname","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":322,"kind":16,"name":"GroupLeftCannotClearClanName","url":"enums/platformerrorcodes.html#groupleftcannotclearclanname","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":323,"kind":16,"name":"GroupRelationshipRequestPending","url":"enums/platformerrorcodes.html#grouprelationshiprequestpending","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":324,"kind":16,"name":"GroupRelationshipRequestBlocked","url":"enums/platformerrorcodes.html#grouprelationshiprequestblocked","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":325,"kind":16,"name":"GroupRelationshipRequestNotFound","url":"enums/platformerrorcodes.html#grouprelationshiprequestnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":326,"kind":16,"name":"GroupRelationshipBlockNotFound","url":"enums/platformerrorcodes.html#grouprelationshipblocknotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":327,"kind":16,"name":"GroupRelationshipNotFound","url":"enums/platformerrorcodes.html#grouprelationshipnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":328,"kind":16,"name":"GroupAlreadyAllied","url":"enums/platformerrorcodes.html#groupalreadyallied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":329,"kind":16,"name":"GroupAlreadyMember","url":"enums/platformerrorcodes.html#groupalreadymember","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":330,"kind":16,"name":"GroupRelationshipAlreadyExists","url":"enums/platformerrorcodes.html#grouprelationshipalreadyexists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":331,"kind":16,"name":"InvalidGroupTypesForRelationshipRequest","url":"enums/platformerrorcodes.html#invalidgrouptypesforrelationshiprequest","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":332,"kind":16,"name":"GroupAtMaximumAlliances","url":"enums/platformerrorcodes.html#groupatmaximumalliances","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":333,"kind":16,"name":"GroupCannotSetClanOnlySettings","url":"enums/platformerrorcodes.html#groupcannotsetclanonlysettings","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":334,"kind":16,"name":"ClanCannotSetTwoDefaultPostTypes","url":"enums/platformerrorcodes.html#clancannotsettwodefaultposttypes","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":335,"kind":16,"name":"GroupMemberInvalidMemberType","url":"enums/platformerrorcodes.html#groupmemberinvalidmembertype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":336,"kind":16,"name":"GroupInvalidPlatformType","url":"enums/platformerrorcodes.html#groupinvalidplatformtype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":337,"kind":16,"name":"GroupMemberInvalidSort","url":"enums/platformerrorcodes.html#groupmemberinvalidsort","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":338,"kind":16,"name":"GroupInvalidResolveState","url":"enums/platformerrorcodes.html#groupinvalidresolvestate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":339,"kind":16,"name":"ClanAlreadyEnabledForPlatform","url":"enums/platformerrorcodes.html#clanalreadyenabledforplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":340,"kind":16,"name":"ClanNotEnabledForPlatform","url":"enums/platformerrorcodes.html#clannotenabledforplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":341,"kind":16,"name":"ClanEnabledButCouldNotJoinNoAccount","url":"enums/platformerrorcodes.html#clanenabledbutcouldnotjoinnoaccount","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":342,"kind":16,"name":"ClanEnabledButCouldNotJoinAlreadyMember","url":"enums/platformerrorcodes.html#clanenabledbutcouldnotjoinalreadymember","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":343,"kind":16,"name":"ClanCannotJoinNoCredential","url":"enums/platformerrorcodes.html#clancannotjoinnocredential","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":344,"kind":16,"name":"NoClanMembershipForPlatform","url":"enums/platformerrorcodes.html#noclanmembershipforplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":345,"kind":16,"name":"GroupToGroupFollowLimitReached","url":"enums/platformerrorcodes.html#grouptogroupfollowlimitreached","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":346,"kind":16,"name":"ChildGroupAlreadyInAlliance","url":"enums/platformerrorcodes.html#childgroupalreadyinalliance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":347,"kind":16,"name":"OwnerGroupAlreadyInAlliance","url":"enums/platformerrorcodes.html#ownergroupalreadyinalliance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":348,"kind":16,"name":"AllianceOwnerCannotJoinAlliance","url":"enums/platformerrorcodes.html#allianceownercannotjoinalliance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":349,"kind":16,"name":"GroupNotInAlliance","url":"enums/platformerrorcodes.html#groupnotinalliance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":350,"kind":16,"name":"ChildGroupCannotInviteToAlliance","url":"enums/platformerrorcodes.html#childgroupcannotinvitetoalliance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":351,"kind":16,"name":"GroupToGroupAlreadyFollowed","url":"enums/platformerrorcodes.html#grouptogroupalreadyfollowed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":352,"kind":16,"name":"GroupToGroupNotFollowing","url":"enums/platformerrorcodes.html#grouptogroupnotfollowing","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":353,"kind":16,"name":"ClanMaximumMembershipReached","url":"enums/platformerrorcodes.html#clanmaximummembershipreached","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":354,"kind":16,"name":"ClanNameNotValid","url":"enums/platformerrorcodes.html#clannamenotvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":355,"kind":16,"name":"ClanNameNotValidError","url":"enums/platformerrorcodes.html#clannamenotvaliderror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":356,"kind":16,"name":"AllianceOwnerNotDefined","url":"enums/platformerrorcodes.html#allianceownernotdefined","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":357,"kind":16,"name":"AllianceChildNotDefined","url":"enums/platformerrorcodes.html#alliancechildnotdefined","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":358,"kind":16,"name":"ClanCultureIllegalCharacters","url":"enums/platformerrorcodes.html#clancultureillegalcharacters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":359,"kind":16,"name":"ClanTagIllegalCharacters","url":"enums/platformerrorcodes.html#clantagillegalcharacters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":360,"kind":16,"name":"ClanRequiresInvitation","url":"enums/platformerrorcodes.html#clanrequiresinvitation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":361,"kind":16,"name":"ClanMembershipClosed","url":"enums/platformerrorcodes.html#clanmembershipclosed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":362,"kind":16,"name":"ClanInviteAlreadyMember","url":"enums/platformerrorcodes.html#claninvitealreadymember","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":363,"kind":16,"name":"GroupInviteAlreadyMember","url":"enums/platformerrorcodes.html#groupinvitealreadymember","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":364,"kind":16,"name":"GroupJoinApprovalRequired","url":"enums/platformerrorcodes.html#groupjoinapprovalrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":365,"kind":16,"name":"ClanTagRequired","url":"enums/platformerrorcodes.html#clantagrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":366,"kind":16,"name":"GroupNameCannotStartOrEndWithWhiteSpace","url":"enums/platformerrorcodes.html#groupnamecannotstartorendwithwhitespace","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":367,"kind":16,"name":"ClanCallsignCannotStartOrEndWithWhiteSpace","url":"enums/platformerrorcodes.html#clancallsigncannotstartorendwithwhitespace","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":368,"kind":16,"name":"ClanMigrationFailed","url":"enums/platformerrorcodes.html#clanmigrationfailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":369,"kind":16,"name":"ClanNotEnabledAlreadyMemberOfAnotherClan","url":"enums/platformerrorcodes.html#clannotenabledalreadymemberofanotherclan","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":370,"kind":16,"name":"GroupModerationNotPermittedOnNonMembers","url":"enums/platformerrorcodes.html#groupmoderationnotpermittedonnonmembers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":371,"kind":16,"name":"ClanCreationInWorldServerFailed","url":"enums/platformerrorcodes.html#clancreationinworldserverfailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":372,"kind":16,"name":"ClanNotFound","url":"enums/platformerrorcodes.html#clannotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":373,"kind":16,"name":"ClanMembershipLevelDoesNotPermitThatAction","url":"enums/platformerrorcodes.html#clanmembershipleveldoesnotpermitthataction","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":374,"kind":16,"name":"ClanMemberNotFound","url":"enums/platformerrorcodes.html#clanmembernotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":375,"kind":16,"name":"ClanMissingMembershipApprovers","url":"enums/platformerrorcodes.html#clanmissingmembershipapprovers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":376,"kind":16,"name":"ClanInWrongStateForRequestedAction","url":"enums/platformerrorcodes.html#claninwrongstateforrequestedaction","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":377,"kind":16,"name":"ClanNameAlreadyUsed","url":"enums/platformerrorcodes.html#clannamealreadyused","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":378,"kind":16,"name":"ClanTooFewMembers","url":"enums/platformerrorcodes.html#clantoofewmembers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":379,"kind":16,"name":"ClanInfoCannotBeWhitespace","url":"enums/platformerrorcodes.html#claninfocannotbewhitespace","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":380,"kind":16,"name":"GroupCultureThrottle","url":"enums/platformerrorcodes.html#groupculturethrottle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":381,"kind":16,"name":"ClanTargetDisallowsInvites","url":"enums/platformerrorcodes.html#clantargetdisallowsinvites","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":382,"kind":16,"name":"ClanInvalidOperation","url":"enums/platformerrorcodes.html#claninvalidoperation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":383,"kind":16,"name":"ClanFounderCannotLeaveWithoutAbdication","url":"enums/platformerrorcodes.html#clanfoundercannotleavewithoutabdication","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":384,"kind":16,"name":"ClanNameReserved","url":"enums/platformerrorcodes.html#clannamereserved","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":385,"kind":16,"name":"ClanApplicantInClanSoNowInvited","url":"enums/platformerrorcodes.html#clanapplicantinclansonowinvited","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":386,"kind":16,"name":"ActivitiesUnknownException","url":"enums/platformerrorcodes.html#activitiesunknownexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":387,"kind":16,"name":"ActivitiesParameterNull","url":"enums/platformerrorcodes.html#activitiesparameternull","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":388,"kind":16,"name":"ActivityCountsDiabled","url":"enums/platformerrorcodes.html#activitycountsdiabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":389,"kind":16,"name":"ActivitySearchInvalidParameters","url":"enums/platformerrorcodes.html#activitysearchinvalidparameters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":390,"kind":16,"name":"ActivityPermissionDenied","url":"enums/platformerrorcodes.html#activitypermissiondenied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":391,"kind":16,"name":"ShareAlreadyShared","url":"enums/platformerrorcodes.html#sharealreadyshared","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":392,"kind":16,"name":"ActivityLoggingDisabled","url":"enums/platformerrorcodes.html#activityloggingdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":393,"kind":16,"name":"ClanRequiresExistingDestinyAccount","url":"enums/platformerrorcodes.html#clanrequiresexistingdestinyaccount","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":394,"kind":16,"name":"ClanNameRestricted","url":"enums/platformerrorcodes.html#clannamerestricted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":395,"kind":16,"name":"ItemAlreadyFollowed","url":"enums/platformerrorcodes.html#itemalreadyfollowed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":396,"kind":16,"name":"ItemNotFollowed","url":"enums/platformerrorcodes.html#itemnotfollowed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":397,"kind":16,"name":"CannotFollowSelf","url":"enums/platformerrorcodes.html#cannotfollowself","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":398,"kind":16,"name":"GroupFollowLimitExceeded","url":"enums/platformerrorcodes.html#groupfollowlimitexceeded","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":399,"kind":16,"name":"TagFollowLimitExceeded","url":"enums/platformerrorcodes.html#tagfollowlimitexceeded","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":400,"kind":16,"name":"UserFollowLimitExceeded","url":"enums/platformerrorcodes.html#userfollowlimitexceeded","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":401,"kind":16,"name":"FollowUnsupportedEntityType","url":"enums/platformerrorcodes.html#followunsupportedentitytype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":402,"kind":16,"name":"NoValidTagsInList","url":"enums/platformerrorcodes.html#novalidtagsinlist","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":403,"kind":16,"name":"BelowMinimumSuggestionLength","url":"enums/platformerrorcodes.html#belowminimumsuggestionlength","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":404,"kind":16,"name":"CannotGetSuggestionsOnMultipleTagsSimultaneously","url":"enums/platformerrorcodes.html#cannotgetsuggestionsonmultipletagssimultaneously","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":405,"kind":16,"name":"NotAValidPartialTag","url":"enums/platformerrorcodes.html#notavalidpartialtag","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":406,"kind":16,"name":"TagSuggestionsUnknownSqlResult","url":"enums/platformerrorcodes.html#tagsuggestionsunknownsqlresult","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":407,"kind":16,"name":"TagsUnableToLoadPopularTagsFromDatabase","url":"enums/platformerrorcodes.html#tagsunabletoloadpopulartagsfromdatabase","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":408,"kind":16,"name":"TagInvalid","url":"enums/platformerrorcodes.html#taginvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":409,"kind":16,"name":"TagNotFound","url":"enums/platformerrorcodes.html#tagnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":410,"kind":16,"name":"SingleTagExpected","url":"enums/platformerrorcodes.html#singletagexpected","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":411,"kind":16,"name":"TagsExceededMaximumPerItem","url":"enums/platformerrorcodes.html#tagsexceededmaximumperitem","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":412,"kind":16,"name":"IgnoreInvalidParameters","url":"enums/platformerrorcodes.html#ignoreinvalidparameters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":413,"kind":16,"name":"IgnoreSqlException","url":"enums/platformerrorcodes.html#ignoresqlexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":414,"kind":16,"name":"IgnoreErrorRetrievingGroupPermissions","url":"enums/platformerrorcodes.html#ignoreerrorretrievinggrouppermissions","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":415,"kind":16,"name":"IgnoreErrorInsufficientPermission","url":"enums/platformerrorcodes.html#ignoreerrorinsufficientpermission","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":416,"kind":16,"name":"IgnoreErrorRetrievingItem","url":"enums/platformerrorcodes.html#ignoreerrorretrievingitem","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":417,"kind":16,"name":"IgnoreCannotIgnoreSelf","url":"enums/platformerrorcodes.html#ignorecannotignoreself","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":418,"kind":16,"name":"IgnoreIllegalType","url":"enums/platformerrorcodes.html#ignoreillegaltype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":419,"kind":16,"name":"IgnoreNotFound","url":"enums/platformerrorcodes.html#ignorenotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":420,"kind":16,"name":"IgnoreUserGloballyIgnored","url":"enums/platformerrorcodes.html#ignoreusergloballyignored","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":421,"kind":16,"name":"IgnoreUserIgnored","url":"enums/platformerrorcodes.html#ignoreuserignored","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":422,"kind":16,"name":"NotificationSettingInvalid","url":"enums/platformerrorcodes.html#notificationsettinginvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":423,"kind":16,"name":"PsnApiExpiredAccessToken","url":"enums/platformerrorcodes.html#psnapiexpiredaccesstoken","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":424,"kind":16,"name":"PSNExForbidden","url":"enums/platformerrorcodes.html#psnexforbidden","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":425,"kind":16,"name":"PSNExSystemDisabled","url":"enums/platformerrorcodes.html#psnexsystemdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":426,"kind":16,"name":"PsnApiErrorCodeUnknown","url":"enums/platformerrorcodes.html#psnapierrorcodeunknown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":427,"kind":16,"name":"PsnApiErrorWebException","url":"enums/platformerrorcodes.html#psnapierrorwebexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":428,"kind":16,"name":"PsnApiBadRequest","url":"enums/platformerrorcodes.html#psnapibadrequest","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":429,"kind":16,"name":"PsnApiAccessTokenRequired","url":"enums/platformerrorcodes.html#psnapiaccesstokenrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":430,"kind":16,"name":"PsnApiInvalidAccessToken","url":"enums/platformerrorcodes.html#psnapiinvalidaccesstoken","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":431,"kind":16,"name":"PsnApiBannedUser","url":"enums/platformerrorcodes.html#psnapibanneduser","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":432,"kind":16,"name":"PsnApiAccountUpgradeRequired","url":"enums/platformerrorcodes.html#psnapiaccountupgraderequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":433,"kind":16,"name":"PsnApiServiceTemporarilyUnavailable","url":"enums/platformerrorcodes.html#psnapiservicetemporarilyunavailable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":434,"kind":16,"name":"PsnApiServerBusy","url":"enums/platformerrorcodes.html#psnapiserverbusy","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":435,"kind":16,"name":"PsnApiUnderMaintenance","url":"enums/platformerrorcodes.html#psnapiundermaintenance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":436,"kind":16,"name":"PsnApiProfileUserNotFound","url":"enums/platformerrorcodes.html#psnapiprofileusernotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":437,"kind":16,"name":"PsnApiProfilePrivacyRestriction","url":"enums/platformerrorcodes.html#psnapiprofileprivacyrestriction","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":438,"kind":16,"name":"PsnApiProfileUnderMaintenance","url":"enums/platformerrorcodes.html#psnapiprofileundermaintenance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":439,"kind":16,"name":"PsnApiAccountAttributeMissing","url":"enums/platformerrorcodes.html#psnapiaccountattributemissing","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":440,"kind":16,"name":"PsnApiNoPermission","url":"enums/platformerrorcodes.html#psnapinopermission","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":441,"kind":16,"name":"PsnApiTargetUserBlocked","url":"enums/platformerrorcodes.html#psnapitargetuserblocked","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":442,"kind":16,"name":"XblExSystemDisabled","url":"enums/platformerrorcodes.html#xblexsystemdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":443,"kind":16,"name":"XblExUnknownError","url":"enums/platformerrorcodes.html#xblexunknownerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":444,"kind":16,"name":"XblApiErrorWebException","url":"enums/platformerrorcodes.html#xblapierrorwebexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":445,"kind":16,"name":"XblStsTokenInvalid","url":"enums/platformerrorcodes.html#xblststokeninvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":446,"kind":16,"name":"XblStsMissingToken","url":"enums/platformerrorcodes.html#xblstsmissingtoken","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":447,"kind":16,"name":"XblStsExpiredToken","url":"enums/platformerrorcodes.html#xblstsexpiredtoken","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":448,"kind":16,"name":"XblAccessToTheSandboxDenied","url":"enums/platformerrorcodes.html#xblaccesstothesandboxdenied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":449,"kind":16,"name":"XblMsaResponseMissing","url":"enums/platformerrorcodes.html#xblmsaresponsemissing","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":450,"kind":16,"name":"XblMsaAccessTokenExpired","url":"enums/platformerrorcodes.html#xblmsaaccesstokenexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":451,"kind":16,"name":"XblMsaInvalidRequest","url":"enums/platformerrorcodes.html#xblmsainvalidrequest","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":452,"kind":16,"name":"XblMsaFriendsRequireSignIn","url":"enums/platformerrorcodes.html#xblmsafriendsrequiresignin","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":453,"kind":16,"name":"XblUserActionRequired","url":"enums/platformerrorcodes.html#xbluseractionrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":454,"kind":16,"name":"XblParentalControls","url":"enums/platformerrorcodes.html#xblparentalcontrols","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":455,"kind":16,"name":"XblDeveloperAccount","url":"enums/platformerrorcodes.html#xbldeveloperaccount","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":456,"kind":16,"name":"XblUserTokenExpired","url":"enums/platformerrorcodes.html#xblusertokenexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":457,"kind":16,"name":"XblUserTokenInvalid","url":"enums/platformerrorcodes.html#xblusertokeninvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":458,"kind":16,"name":"XblOffline","url":"enums/platformerrorcodes.html#xbloffline","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":459,"kind":16,"name":"XblUnknownErrorCode","url":"enums/platformerrorcodes.html#xblunknownerrorcode","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":460,"kind":16,"name":"XblMsaInvalidGrant","url":"enums/platformerrorcodes.html#xblmsainvalidgrant","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":461,"kind":16,"name":"ReportNotYetResolved","url":"enums/platformerrorcodes.html#reportnotyetresolved","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":462,"kind":16,"name":"ReportOverturnDoesNotChangeDecision","url":"enums/platformerrorcodes.html#reportoverturndoesnotchangedecision","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":463,"kind":16,"name":"ReportNotFound","url":"enums/platformerrorcodes.html#reportnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":464,"kind":16,"name":"ReportAlreadyReported","url":"enums/platformerrorcodes.html#reportalreadyreported","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":465,"kind":16,"name":"ReportInvalidResolution","url":"enums/platformerrorcodes.html#reportinvalidresolution","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":466,"kind":16,"name":"ReportNotAssignedToYou","url":"enums/platformerrorcodes.html#reportnotassignedtoyou","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":467,"kind":16,"name":"LegacyGameStatsSystemDisabled","url":"enums/platformerrorcodes.html#legacygamestatssystemdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":468,"kind":16,"name":"LegacyGameStatsUnknownError","url":"enums/platformerrorcodes.html#legacygamestatsunknownerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":469,"kind":16,"name":"LegacyGameStatsMalformedSneakerNetCode","url":"enums/platformerrorcodes.html#legacygamestatsmalformedsneakernetcode","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":470,"kind":16,"name":"DestinyAccountAcquisitionFailure","url":"enums/platformerrorcodes.html#destinyaccountacquisitionfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":471,"kind":16,"name":"DestinyAccountNotFound","url":"enums/platformerrorcodes.html#destinyaccountnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":472,"kind":16,"name":"DestinyBuildStatsDatabaseError","url":"enums/platformerrorcodes.html#destinybuildstatsdatabaseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":473,"kind":16,"name":"DestinyCharacterStatsDatabaseError","url":"enums/platformerrorcodes.html#destinycharacterstatsdatabaseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":474,"kind":16,"name":"DestinyPvPStatsDatabaseError","url":"enums/platformerrorcodes.html#destinypvpstatsdatabaseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":475,"kind":16,"name":"DestinyPvEStatsDatabaseError","url":"enums/platformerrorcodes.html#destinypvestatsdatabaseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":476,"kind":16,"name":"DestinyGrimoireStatsDatabaseError","url":"enums/platformerrorcodes.html#destinygrimoirestatsdatabaseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":477,"kind":16,"name":"DestinyStatsParameterMembershipTypeParseError","url":"enums/platformerrorcodes.html#destinystatsparametermembershiptypeparseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":478,"kind":16,"name":"DestinyStatsParameterMembershipIdParseError","url":"enums/platformerrorcodes.html#destinystatsparametermembershipidparseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":479,"kind":16,"name":"DestinyStatsParameterRangeParseError","url":"enums/platformerrorcodes.html#destinystatsparameterrangeparseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":480,"kind":16,"name":"DestinyStringItemHashNotFound","url":"enums/platformerrorcodes.html#destinystringitemhashnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":481,"kind":16,"name":"DestinyStringSetNotFound","url":"enums/platformerrorcodes.html#destinystringsetnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":482,"kind":16,"name":"DestinyContentLookupNotFoundForKey","url":"enums/platformerrorcodes.html#destinycontentlookupnotfoundforkey","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":483,"kind":16,"name":"DestinyContentItemNotFound","url":"enums/platformerrorcodes.html#destinycontentitemnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":484,"kind":16,"name":"DestinyContentSectionNotFound","url":"enums/platformerrorcodes.html#destinycontentsectionnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":485,"kind":16,"name":"DestinyContentPropertyNotFound","url":"enums/platformerrorcodes.html#destinycontentpropertynotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":486,"kind":16,"name":"DestinyContentConfigNotFound","url":"enums/platformerrorcodes.html#destinycontentconfignotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":487,"kind":16,"name":"DestinyContentPropertyBucketValueNotFound","url":"enums/platformerrorcodes.html#destinycontentpropertybucketvaluenotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":488,"kind":16,"name":"DestinyUnexpectedError","url":"enums/platformerrorcodes.html#destinyunexpectederror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":489,"kind":16,"name":"DestinyInvalidAction","url":"enums/platformerrorcodes.html#destinyinvalidaction","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":490,"kind":16,"name":"DestinyCharacterNotFound","url":"enums/platformerrorcodes.html#destinycharacternotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":491,"kind":16,"name":"DestinyInvalidFlag","url":"enums/platformerrorcodes.html#destinyinvalidflag","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":492,"kind":16,"name":"DestinyInvalidRequest","url":"enums/platformerrorcodes.html#destinyinvalidrequest","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":493,"kind":16,"name":"DestinyItemNotFound","url":"enums/platformerrorcodes.html#destinyitemnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":494,"kind":16,"name":"DestinyInvalidCustomizationChoices","url":"enums/platformerrorcodes.html#destinyinvalidcustomizationchoices","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":495,"kind":16,"name":"DestinyVendorItemNotFound","url":"enums/platformerrorcodes.html#destinyvendoritemnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":496,"kind":16,"name":"DestinyInternalError","url":"enums/platformerrorcodes.html#destinyinternalerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":497,"kind":16,"name":"DestinyVendorNotFound","url":"enums/platformerrorcodes.html#destinyvendornotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":498,"kind":16,"name":"DestinyRecentActivitiesDatabaseError","url":"enums/platformerrorcodes.html#destinyrecentactivitiesdatabaseerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":499,"kind":16,"name":"DestinyItemBucketNotFound","url":"enums/platformerrorcodes.html#destinyitembucketnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":500,"kind":16,"name":"DestinyInvalidMembershipType","url":"enums/platformerrorcodes.html#destinyinvalidmembershiptype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":501,"kind":16,"name":"DestinyVersionIncompatibility","url":"enums/platformerrorcodes.html#destinyversionincompatibility","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":502,"kind":16,"name":"DestinyItemAlreadyInInventory","url":"enums/platformerrorcodes.html#destinyitemalreadyininventory","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":503,"kind":16,"name":"DestinyBucketNotFound","url":"enums/platformerrorcodes.html#destinybucketnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":504,"kind":16,"name":"DestinyCharacterNotInTower","url":"enums/platformerrorcodes.html#destinycharacternotintower","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":505,"kind":16,"name":"DestinyCharacterNotLoggedIn","url":"enums/platformerrorcodes.html#destinycharacternotloggedin","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":506,"kind":16,"name":"DestinyDefinitionsNotLoaded","url":"enums/platformerrorcodes.html#destinydefinitionsnotloaded","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":507,"kind":16,"name":"DestinyInventoryFull","url":"enums/platformerrorcodes.html#destinyinventoryfull","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":508,"kind":16,"name":"DestinyItemFailedLevelCheck","url":"enums/platformerrorcodes.html#destinyitemfailedlevelcheck","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":509,"kind":16,"name":"DestinyItemFailedUnlockCheck","url":"enums/platformerrorcodes.html#destinyitemfailedunlockcheck","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":510,"kind":16,"name":"DestinyItemUnequippable","url":"enums/platformerrorcodes.html#destinyitemunequippable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":511,"kind":16,"name":"DestinyItemUniqueEquipRestricted","url":"enums/platformerrorcodes.html#destinyitemuniqueequiprestricted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":512,"kind":16,"name":"DestinyNoRoomInDestination","url":"enums/platformerrorcodes.html#destinynoroomindestination","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":513,"kind":16,"name":"DestinyServiceFailure","url":"enums/platformerrorcodes.html#destinyservicefailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":514,"kind":16,"name":"DestinyServiceRetired","url":"enums/platformerrorcodes.html#destinyserviceretired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":515,"kind":16,"name":"DestinyTransferFailed","url":"enums/platformerrorcodes.html#destinytransferfailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":516,"kind":16,"name":"DestinyTransferNotFoundForSourceBucket","url":"enums/platformerrorcodes.html#destinytransfernotfoundforsourcebucket","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":517,"kind":16,"name":"DestinyUnexpectedResultInVendorTransferCheck","url":"enums/platformerrorcodes.html#destinyunexpectedresultinvendortransfercheck","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":518,"kind":16,"name":"DestinyUniquenessViolation","url":"enums/platformerrorcodes.html#destinyuniquenessviolation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":519,"kind":16,"name":"DestinyErrorDeserializationFailure","url":"enums/platformerrorcodes.html#destinyerrordeserializationfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":520,"kind":16,"name":"DestinyValidAccountTicketRequired","url":"enums/platformerrorcodes.html#destinyvalidaccountticketrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":521,"kind":16,"name":"DestinyShardRelayClientTimeout","url":"enums/platformerrorcodes.html#destinyshardrelayclienttimeout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":522,"kind":16,"name":"DestinyShardRelayProxyTimeout","url":"enums/platformerrorcodes.html#destinyshardrelayproxytimeout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":523,"kind":16,"name":"DestinyPGCRNotFound","url":"enums/platformerrorcodes.html#destinypgcrnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":524,"kind":16,"name":"DestinyAccountMustBeOffline","url":"enums/platformerrorcodes.html#destinyaccountmustbeoffline","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":525,"kind":16,"name":"DestinyCanOnlyEquipInGame","url":"enums/platformerrorcodes.html#destinycanonlyequipingame","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":526,"kind":16,"name":"DestinyCannotPerformActionOnEquippedItem","url":"enums/platformerrorcodes.html#destinycannotperformactiononequippeditem","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":527,"kind":16,"name":"DestinyQuestAlreadyCompleted","url":"enums/platformerrorcodes.html#destinyquestalreadycompleted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":528,"kind":16,"name":"DestinyQuestAlreadyTracked","url":"enums/platformerrorcodes.html#destinyquestalreadytracked","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":529,"kind":16,"name":"DestinyTrackableQuestsFull","url":"enums/platformerrorcodes.html#destinytrackablequestsfull","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":530,"kind":16,"name":"DestinyItemNotTransferrable","url":"enums/platformerrorcodes.html#destinyitemnottransferrable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":531,"kind":16,"name":"DestinyVendorPurchaseNotAllowed","url":"enums/platformerrorcodes.html#destinyvendorpurchasenotallowed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":532,"kind":16,"name":"DestinyContentVersionMismatch","url":"enums/platformerrorcodes.html#destinycontentversionmismatch","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":533,"kind":16,"name":"DestinyItemActionForbidden","url":"enums/platformerrorcodes.html#destinyitemactionforbidden","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":534,"kind":16,"name":"DestinyRefundInvalid","url":"enums/platformerrorcodes.html#destinyrefundinvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":535,"kind":16,"name":"DestinyPrivacyRestriction","url":"enums/platformerrorcodes.html#destinyprivacyrestriction","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":536,"kind":16,"name":"DestinyActionInsufficientPrivileges","url":"enums/platformerrorcodes.html#destinyactioninsufficientprivileges","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":537,"kind":16,"name":"DestinyInvalidClaimException","url":"enums/platformerrorcodes.html#destinyinvalidclaimexception","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":538,"kind":16,"name":"DestinyLegacyPlatformRestricted","url":"enums/platformerrorcodes.html#destinylegacyplatformrestricted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":539,"kind":16,"name":"DestinyLegacyPlatformInUse","url":"enums/platformerrorcodes.html#destinylegacyplatforminuse","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":540,"kind":16,"name":"DestinyLegacyPlatformInaccessible","url":"enums/platformerrorcodes.html#destinylegacyplatforminaccessible","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":541,"kind":16,"name":"DestinyCannotPerformActionAtThisLocation","url":"enums/platformerrorcodes.html#destinycannotperformactionatthislocation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":542,"kind":16,"name":"DestinyThrottledByGameServer","url":"enums/platformerrorcodes.html#destinythrottledbygameserver","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":543,"kind":16,"name":"DestinyItemNotTransferrableHasSideEffects","url":"enums/platformerrorcodes.html#destinyitemnottransferrablehassideeffects","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":544,"kind":16,"name":"DestinyItemLocked","url":"enums/platformerrorcodes.html#destinyitemlocked","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":545,"kind":16,"name":"DestinyCannotAffordMaterialRequirements","url":"enums/platformerrorcodes.html#destinycannotaffordmaterialrequirements","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":546,"kind":16,"name":"DestinyFailedPlugInsertionRules","url":"enums/platformerrorcodes.html#destinyfailedpluginsertionrules","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":547,"kind":16,"name":"DestinySocketNotFound","url":"enums/platformerrorcodes.html#destinysocketnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":548,"kind":16,"name":"DestinySocketActionNotAllowed","url":"enums/platformerrorcodes.html#destinysocketactionnotallowed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":549,"kind":16,"name":"DestinySocketAlreadyHasPlug","url":"enums/platformerrorcodes.html#destinysocketalreadyhasplug","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":550,"kind":16,"name":"DestinyPlugItemNotAvailable","url":"enums/platformerrorcodes.html#destinyplugitemnotavailable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":551,"kind":16,"name":"DestinyCharacterLoggedInNotAllowed","url":"enums/platformerrorcodes.html#destinycharacterloggedinnotallowed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":552,"kind":16,"name":"DestinyPublicAccountNotAccessible","url":"enums/platformerrorcodes.html#destinypublicaccountnotaccessible","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":553,"kind":16,"name":"FbInvalidRequest","url":"enums/platformerrorcodes.html#fbinvalidrequest","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":554,"kind":16,"name":"FbRedirectMismatch","url":"enums/platformerrorcodes.html#fbredirectmismatch","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":555,"kind":16,"name":"FbAccessDenied","url":"enums/platformerrorcodes.html#fbaccessdenied","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":556,"kind":16,"name":"FbUnsupportedResponseType","url":"enums/platformerrorcodes.html#fbunsupportedresponsetype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":557,"kind":16,"name":"FbInvalidScope","url":"enums/platformerrorcodes.html#fbinvalidscope","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":558,"kind":16,"name":"FbUnsupportedGrantType","url":"enums/platformerrorcodes.html#fbunsupportedgranttype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":559,"kind":16,"name":"FbInvalidGrant","url":"enums/platformerrorcodes.html#fbinvalidgrant","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":560,"kind":16,"name":"InvitationExpired","url":"enums/platformerrorcodes.html#invitationexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":561,"kind":16,"name":"InvitationUnknownType","url":"enums/platformerrorcodes.html#invitationunknowntype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":562,"kind":16,"name":"InvitationInvalidResponseStatus","url":"enums/platformerrorcodes.html#invitationinvalidresponsestatus","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":563,"kind":16,"name":"InvitationInvalidType","url":"enums/platformerrorcodes.html#invitationinvalidtype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":564,"kind":16,"name":"InvitationAlreadyPending","url":"enums/platformerrorcodes.html#invitationalreadypending","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":565,"kind":16,"name":"InvitationInsufficientPermission","url":"enums/platformerrorcodes.html#invitationinsufficientpermission","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":566,"kind":16,"name":"InvitationInvalidCode","url":"enums/platformerrorcodes.html#invitationinvalidcode","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":567,"kind":16,"name":"InvitationInvalidTargetState","url":"enums/platformerrorcodes.html#invitationinvalidtargetstate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":568,"kind":16,"name":"InvitationCannotBeReactivated","url":"enums/platformerrorcodes.html#invitationcannotbereactivated","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":569,"kind":16,"name":"InvitationNoRecipients","url":"enums/platformerrorcodes.html#invitationnorecipients","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":570,"kind":16,"name":"InvitationGroupCannotSendToSelf","url":"enums/platformerrorcodes.html#invitationgroupcannotsendtoself","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":571,"kind":16,"name":"InvitationTooManyRecipients","url":"enums/platformerrorcodes.html#invitationtoomanyrecipients","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":572,"kind":16,"name":"InvitationInvalid","url":"enums/platformerrorcodes.html#invitationinvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":573,"kind":16,"name":"InvitationNotFound","url":"enums/platformerrorcodes.html#invitationnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":574,"kind":16,"name":"TokenInvalid","url":"enums/platformerrorcodes.html#tokeninvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":575,"kind":16,"name":"TokenBadFormat","url":"enums/platformerrorcodes.html#tokenbadformat","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":576,"kind":16,"name":"TokenAlreadyClaimed","url":"enums/platformerrorcodes.html#tokenalreadyclaimed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":577,"kind":16,"name":"TokenAlreadyClaimedSelf","url":"enums/platformerrorcodes.html#tokenalreadyclaimedself","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":578,"kind":16,"name":"TokenThrottling","url":"enums/platformerrorcodes.html#tokenthrottling","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":579,"kind":16,"name":"TokenUnknownRedemptionFailure","url":"enums/platformerrorcodes.html#tokenunknownredemptionfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":580,"kind":16,"name":"TokenPurchaseClaimFailedAfterTokenClaimed","url":"enums/platformerrorcodes.html#tokenpurchaseclaimfailedaftertokenclaimed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":581,"kind":16,"name":"TokenUserAlreadyOwnsOffer","url":"enums/platformerrorcodes.html#tokenuseralreadyownsoffer","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":582,"kind":16,"name":"TokenInvalidOfferKey","url":"enums/platformerrorcodes.html#tokeninvalidofferkey","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":583,"kind":16,"name":"TokenEmailNotValidated","url":"enums/platformerrorcodes.html#tokenemailnotvalidated","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":584,"kind":16,"name":"TokenProvisioningBadVendorOrOffer","url":"enums/platformerrorcodes.html#tokenprovisioningbadvendororoffer","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":585,"kind":16,"name":"TokenPurchaseHistoryUnknownError","url":"enums/platformerrorcodes.html#tokenpurchasehistoryunknownerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":586,"kind":16,"name":"TokenThrottleStateUnknownError","url":"enums/platformerrorcodes.html#tokenthrottlestateunknownerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":587,"kind":16,"name":"TokenUserAgeNotVerified","url":"enums/platformerrorcodes.html#tokenuseragenotverified","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":588,"kind":16,"name":"TokenExceededOfferMaximum","url":"enums/platformerrorcodes.html#tokenexceededoffermaximum","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":589,"kind":16,"name":"TokenNoAvailableUnlocks","url":"enums/platformerrorcodes.html#tokennoavailableunlocks","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":590,"kind":16,"name":"TokenMarketplaceInvalidPlatform","url":"enums/platformerrorcodes.html#tokenmarketplaceinvalidplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":591,"kind":16,"name":"TokenNoMarketplaceCodesFound","url":"enums/platformerrorcodes.html#tokennomarketplacecodesfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":592,"kind":16,"name":"TokenOfferNotAvailableForRedemption","url":"enums/platformerrorcodes.html#tokenoffernotavailableforredemption","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":593,"kind":16,"name":"TokenUnlockPartialFailure","url":"enums/platformerrorcodes.html#tokenunlockpartialfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":594,"kind":16,"name":"TokenMarketplaceInvalidRegion","url":"enums/platformerrorcodes.html#tokenmarketplaceinvalidregion","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":595,"kind":16,"name":"TokenOfferExpired","url":"enums/platformerrorcodes.html#tokenofferexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":596,"kind":16,"name":"RAFExceededMaximumReferrals","url":"enums/platformerrorcodes.html#rafexceededmaximumreferrals","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":597,"kind":16,"name":"RAFDuplicateBond","url":"enums/platformerrorcodes.html#rafduplicatebond","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":598,"kind":16,"name":"RAFNoValidVeteranDestinyMembershipsFound","url":"enums/platformerrorcodes.html#rafnovalidveterandestinymembershipsfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":599,"kind":16,"name":"RAFNotAValidVeteranUser","url":"enums/platformerrorcodes.html#rafnotavalidveteranuser","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":600,"kind":16,"name":"RAFCodeAlreadyClaimedOrNotFound","url":"enums/platformerrorcodes.html#rafcodealreadyclaimedornotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":601,"kind":16,"name":"RAFMismatchedDestinyMembershipType","url":"enums/platformerrorcodes.html#rafmismatcheddestinymembershiptype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":602,"kind":16,"name":"RAFUnableToAccessPurchaseHistory","url":"enums/platformerrorcodes.html#rafunabletoaccesspurchasehistory","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":603,"kind":16,"name":"RAFUnableToCreateBond","url":"enums/platformerrorcodes.html#rafunabletocreatebond","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":604,"kind":16,"name":"RAFUnableToFindBond","url":"enums/platformerrorcodes.html#rafunabletofindbond","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":605,"kind":16,"name":"RAFUnableToRemoveBond","url":"enums/platformerrorcodes.html#rafunabletoremovebond","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":606,"kind":16,"name":"RAFCannotBondToSelf","url":"enums/platformerrorcodes.html#rafcannotbondtoself","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":607,"kind":16,"name":"RAFInvalidPlatform","url":"enums/platformerrorcodes.html#rafinvalidplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":608,"kind":16,"name":"RAFGenerateThrottled","url":"enums/platformerrorcodes.html#rafgeneratethrottled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":609,"kind":16,"name":"RAFUnableToCreateBondVersionMismatch","url":"enums/platformerrorcodes.html#rafunabletocreatebondversionmismatch","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":610,"kind":16,"name":"RAFUnableToRemoveBondVersionMismatch","url":"enums/platformerrorcodes.html#rafunabletoremovebondversionmismatch","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":611,"kind":16,"name":"RAFRedeemThrottled","url":"enums/platformerrorcodes.html#rafredeemthrottled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":612,"kind":16,"name":"NoAvailableDiscountCode","url":"enums/platformerrorcodes.html#noavailablediscountcode","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":613,"kind":16,"name":"DiscountAlreadyClaimed","url":"enums/platformerrorcodes.html#discountalreadyclaimed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":614,"kind":16,"name":"DiscountClaimFailure","url":"enums/platformerrorcodes.html#discountclaimfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":615,"kind":16,"name":"DiscountConfigurationFailure","url":"enums/platformerrorcodes.html#discountconfigurationfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":616,"kind":16,"name":"DiscountGenerationFailure","url":"enums/platformerrorcodes.html#discountgenerationfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":617,"kind":16,"name":"DiscountAlreadyExists","url":"enums/platformerrorcodes.html#discountalreadyexists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":618,"kind":16,"name":"TokenRequiresCredentialXuid","url":"enums/platformerrorcodes.html#tokenrequirescredentialxuid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":619,"kind":16,"name":"TokenRequiresCredentialPsnid","url":"enums/platformerrorcodes.html#tokenrequirescredentialpsnid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":620,"kind":16,"name":"OfferRequired","url":"enums/platformerrorcodes.html#offerrequired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":621,"kind":16,"name":"UnknownEververseHistoryError","url":"enums/platformerrorcodes.html#unknowneverversehistoryerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":622,"kind":16,"name":"MissingEververseHistoryError","url":"enums/platformerrorcodes.html#missingeverversehistoryerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":623,"kind":16,"name":"BungieRewardEmailStateInvalid","url":"enums/platformerrorcodes.html#bungierewardemailstateinvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":624,"kind":16,"name":"BungieRewardNotYetClaimable","url":"enums/platformerrorcodes.html#bungierewardnotyetclaimable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":625,"kind":16,"name":"MissingOfferConfig","url":"enums/platformerrorcodes.html#missingofferconfig","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":626,"kind":16,"name":"RAFQuestEntitlementRequiresBnet","url":"enums/platformerrorcodes.html#rafquestentitlementrequiresbnet","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":627,"kind":16,"name":"RAFQuestEntitlementTransportFailure","url":"enums/platformerrorcodes.html#rafquestentitlementtransportfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":628,"kind":16,"name":"RAFQuestEntitlementUnknownFailure","url":"enums/platformerrorcodes.html#rafquestentitlementunknownfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":629,"kind":16,"name":"RAFVeteranRewardUnknownFailure","url":"enums/platformerrorcodes.html#rafveteranrewardunknownfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":630,"kind":16,"name":"RAFTooEarlyToCancelBond","url":"enums/platformerrorcodes.html#raftooearlytocancelbond","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":631,"kind":16,"name":"ApiExceededMaxKeys","url":"enums/platformerrorcodes.html#apiexceededmaxkeys","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":632,"kind":16,"name":"ApiInvalidOrExpiredKey","url":"enums/platformerrorcodes.html#apiinvalidorexpiredkey","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":633,"kind":16,"name":"ApiKeyMissingFromRequest","url":"enums/platformerrorcodes.html#apikeymissingfromrequest","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":634,"kind":16,"name":"ApplicationDisabled","url":"enums/platformerrorcodes.html#applicationdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":635,"kind":16,"name":"ApplicationExceededMax","url":"enums/platformerrorcodes.html#applicationexceededmax","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":636,"kind":16,"name":"ApplicationDisallowedByScope","url":"enums/platformerrorcodes.html#applicationdisallowedbyscope","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":637,"kind":16,"name":"AuthorizationCodeInvalid","url":"enums/platformerrorcodes.html#authorizationcodeinvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":638,"kind":16,"name":"OriginHeaderDoesNotMatchKey","url":"enums/platformerrorcodes.html#originheaderdoesnotmatchkey","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":639,"kind":16,"name":"AccessNotPermittedByApplicationScope","url":"enums/platformerrorcodes.html#accessnotpermittedbyapplicationscope","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":640,"kind":16,"name":"ApplicationNameIsTaken","url":"enums/platformerrorcodes.html#applicationnameistaken","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":641,"kind":16,"name":"RefreshTokenNotYetValid","url":"enums/platformerrorcodes.html#refreshtokennotyetvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":642,"kind":16,"name":"AccessTokenHasExpired","url":"enums/platformerrorcodes.html#accesstokenhasexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":643,"kind":16,"name":"ApplicationTokenFormatNotValid","url":"enums/platformerrorcodes.html#applicationtokenformatnotvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":644,"kind":16,"name":"ApplicationNotConfiguredForBungieAuth","url":"enums/platformerrorcodes.html#applicationnotconfiguredforbungieauth","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":645,"kind":16,"name":"ApplicationNotConfiguredForOAuth","url":"enums/platformerrorcodes.html#applicationnotconfiguredforoauth","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":646,"kind":16,"name":"OAuthAccessTokenExpired","url":"enums/platformerrorcodes.html#oauthaccesstokenexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":647,"kind":16,"name":"PartnershipInvalidType","url":"enums/platformerrorcodes.html#partnershipinvalidtype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":648,"kind":16,"name":"PartnershipValidationError","url":"enums/platformerrorcodes.html#partnershipvalidationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":649,"kind":16,"name":"PartnershipValidationTimeout","url":"enums/platformerrorcodes.html#partnershipvalidationtimeout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":650,"kind":16,"name":"PartnershipAccessFailure","url":"enums/platformerrorcodes.html#partnershipaccessfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":651,"kind":16,"name":"PartnershipAccountInvalid","url":"enums/platformerrorcodes.html#partnershipaccountinvalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":652,"kind":16,"name":"PartnershipGetAccountInfoFailure","url":"enums/platformerrorcodes.html#partnershipgetaccountinfofailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":653,"kind":16,"name":"PartnershipDisabled","url":"enums/platformerrorcodes.html#partnershipdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":654,"kind":16,"name":"PartnershipAlreadyExists","url":"enums/platformerrorcodes.html#partnershipalreadyexists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":655,"kind":16,"name":"CommunityStreamingUnavailable","url":"enums/platformerrorcodes.html#communitystreamingunavailable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":656,"kind":16,"name":"TwitchNotLinked","url":"enums/platformerrorcodes.html#twitchnotlinked","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":657,"kind":16,"name":"TwitchAccountNotFound","url":"enums/platformerrorcodes.html#twitchaccountnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":658,"kind":16,"name":"TwitchCouldNotLoadDestinyInfo","url":"enums/platformerrorcodes.html#twitchcouldnotloaddestinyinfo","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":659,"kind":16,"name":"TrendingCategoryNotFound","url":"enums/platformerrorcodes.html#trendingcategorynotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":660,"kind":16,"name":"TrendingEntryTypeNotSupported","url":"enums/platformerrorcodes.html#trendingentrytypenotsupported","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":661,"kind":16,"name":"ReportOffenderNotInPgcr","url":"enums/platformerrorcodes.html#reportoffendernotinpgcr","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":662,"kind":16,"name":"ReportRequestorNotInPgcr","url":"enums/platformerrorcodes.html#reportrequestornotinpgcr","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":663,"kind":16,"name":"ReportSubmissionFailed","url":"enums/platformerrorcodes.html#reportsubmissionfailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":664,"kind":16,"name":"ReportCannotReportSelf","url":"enums/platformerrorcodes.html#reportcannotreportself","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":665,"kind":16,"name":"AwaTypeDisabled","url":"enums/platformerrorcodes.html#awatypedisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":666,"kind":16,"name":"AwaTooManyPendingRequests","url":"enums/platformerrorcodes.html#awatoomanypendingrequests","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":667,"kind":16,"name":"AwaTheFeatureRequiresARegisteredDevice","url":"enums/platformerrorcodes.html#awathefeaturerequiresaregistereddevice","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":668,"kind":16,"name":"AwaRequestWasUnansweredForTooLong","url":"enums/platformerrorcodes.html#awarequestwasunansweredfortoolong","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":669,"kind":16,"name":"AwaWriteRequestMissingOrInvalidToken","url":"enums/platformerrorcodes.html#awawriterequestmissingorinvalidtoken","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":670,"kind":16,"name":"AwaWriteRequestTokenExpired","url":"enums/platformerrorcodes.html#awawriterequesttokenexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":671,"kind":16,"name":"AwaWriteRequestTokenUsageLimitReached","url":"enums/platformerrorcodes.html#awawriterequesttokenusagelimitreached","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":672,"kind":16,"name":"ClanFireteamNotFound","url":"enums/platformerrorcodes.html#clanfireteamnotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":673,"kind":16,"name":"ClanFireteamAddNoAlternatesForImmediate","url":"enums/platformerrorcodes.html#clanfireteamaddnoalternatesforimmediate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":674,"kind":16,"name":"ClanFireteamFull","url":"enums/platformerrorcodes.html#clanfireteamfull","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":675,"kind":16,"name":"ClanFireteamAltFull","url":"enums/platformerrorcodes.html#clanfireteamaltfull","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":676,"kind":16,"name":"ClanFireteamBlocked","url":"enums/platformerrorcodes.html#clanfireteamblocked","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":677,"kind":16,"name":"ClanFireteamPlayerEntryNotFound","url":"enums/platformerrorcodes.html#clanfireteamplayerentrynotfound","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":678,"kind":16,"name":"ClanFireteamPermissions","url":"enums/platformerrorcodes.html#clanfireteampermissions","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":679,"kind":16,"name":"ClanFireteamInvalidPlatform","url":"enums/platformerrorcodes.html#clanfireteaminvalidplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":680,"kind":16,"name":"ClanFireteamCannotAdjustSlotCount","url":"enums/platformerrorcodes.html#clanfireteamcannotadjustslotcount","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":681,"kind":16,"name":"ClanFireteamInvalidPlayerPlatform","url":"enums/platformerrorcodes.html#clanfireteaminvalidplayerplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":682,"kind":16,"name":"ClanFireteamNotReadyForInvitesNotEnoughPlayers","url":"enums/platformerrorcodes.html#clanfireteamnotreadyforinvitesnotenoughplayers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":683,"kind":16,"name":"ClanFireteamGameInvitesNotSupportForPlatform","url":"enums/platformerrorcodes.html#clanfireteamgameinvitesnotsupportforplatform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":684,"kind":16,"name":"ClanFireteamPlatformInvitePreqFailure","url":"enums/platformerrorcodes.html#clanfireteamplatforminvitepreqfailure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":685,"kind":16,"name":"ClanFireteamInvalidAuthContext","url":"enums/platformerrorcodes.html#clanfireteaminvalidauthcontext","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":686,"kind":16,"name":"ClanFireteamInvalidAuthProviderPsn","url":"enums/platformerrorcodes.html#clanfireteaminvalidauthproviderpsn","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":687,"kind":16,"name":"ClanFireteamPs4SessionFull","url":"enums/platformerrorcodes.html#clanfireteamps4sessionfull","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":688,"kind":16,"name":"ClanFireteamInvalidAuthToken","url":"enums/platformerrorcodes.html#clanfireteaminvalidauthtoken","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":689,"kind":16,"name":"ClanFireteamScheduledFireteamsDisabled","url":"enums/platformerrorcodes.html#clanfireteamscheduledfireteamsdisabled","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":690,"kind":16,"name":"ClanFireteamNotReadyForInvitesNotScheduledYet","url":"enums/platformerrorcodes.html#clanfireteamnotreadyforinvitesnotscheduledyet","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":691,"kind":16,"name":"ClanFireteamNotReadyForInvitesClosed","url":"enums/platformerrorcodes.html#clanfireteamnotreadyforinvitesclosed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":692,"kind":16,"name":"ClanFireteamScheduledFireteamsRequireAdminPermissions","url":"enums/platformerrorcodes.html#clanfireteamscheduledfireteamsrequireadminpermissions","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":693,"kind":16,"name":"ClanFireteamNonPublicMustHaveClan","url":"enums/platformerrorcodes.html#clanfireteamnonpublicmusthaveclan","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":694,"kind":16,"name":"ClanFireteamPublicCreationRestriction","url":"enums/platformerrorcodes.html#clanfireteampubliccreationrestriction","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":695,"kind":16,"name":"ClanFireteamAlreadyJoined","url":"enums/platformerrorcodes.html#clanfireteamalreadyjoined","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":696,"kind":16,"name":"ClanFireteamScheduledFireteamsRange","url":"enums/platformerrorcodes.html#clanfireteamscheduledfireteamsrange","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":697,"kind":16,"name":"ClanFireteamPublicCreationRestrictionExtended","url":"enums/platformerrorcodes.html#clanfireteampubliccreationrestrictionextended","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":698,"kind":16,"name":"ClanFireteamExpired","url":"enums/platformerrorcodes.html#clanfireteamexpired","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PlatformErrorCodes"},{"id":699,"kind":4,"name":"BungieMembershipType","url":"enums/bungiemembershiptype.html","classes":"tsd-kind-enum"},{"id":700,"kind":16,"name":"None","url":"enums/bungiemembershiptype.html#none","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BungieMembershipType"},{"id":701,"kind":16,"name":"TigerXbox","url":"enums/bungiemembershiptype.html#tigerxbox","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BungieMembershipType"},{"id":702,"kind":16,"name":"TigerPsn","url":"enums/bungiemembershiptype.html#tigerpsn","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BungieMembershipType"},{"id":703,"kind":16,"name":"TigerBlizzard","url":"enums/bungiemembershiptype.html#tigerblizzard","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BungieMembershipType"},{"id":704,"kind":16,"name":"TigerDemon","url":"enums/bungiemembershiptype.html#tigerdemon","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BungieMembershipType"},{"id":705,"kind":16,"name":"BungieNext","url":"enums/bungiemembershiptype.html#bungienext","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BungieMembershipType"},{"id":706,"kind":16,"name":"All","url":"enums/bungiemembershiptype.html#all","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BungieMembershipType"},{"id":707,"kind":256,"name":"PagedQuery","url":"interfaces/pagedquery.html","classes":"tsd-kind-interface"},{"id":708,"kind":1024,"name":"itemsPerPage","url":"interfaces/pagedquery.html#itemsperpage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PagedQuery"},{"id":709,"kind":1024,"name":"currentPage","url":"interfaces/pagedquery.html#currentpage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PagedQuery"},{"id":710,"kind":1024,"name":"requestContinuationToken","url":"interfaces/pagedquery.html#requestcontinuationtoken","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PagedQuery"},{"id":711,"kind":256,"name":"InterpolationPoint","url":"interfaces/interpolationpoint.html","classes":"tsd-kind-interface"},{"id":712,"kind":1024,"name":"value","url":"interfaces/interpolationpoint.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InterpolationPoint"},{"id":713,"kind":1024,"name":"weight","url":"interfaces/interpolationpoint.html#weight","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InterpolationPoint"},{"id":714,"kind":256,"name":"InterpolationPointFloat","url":"interfaces/interpolationpointfloat.html","classes":"tsd-kind-interface"},{"id":715,"kind":1024,"name":"value","url":"interfaces/interpolationpointfloat.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InterpolationPointFloat"},{"id":716,"kind":1024,"name":"weight","url":"interfaces/interpolationpointfloat.html#weight","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InterpolationPointFloat"},{"id":717,"kind":256,"name":"HyperlinkReference","url":"interfaces/hyperlinkreference.html","classes":"tsd-kind-interface"},{"id":718,"kind":1024,"name":"title","url":"interfaces/hyperlinkreference.html#title","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"HyperlinkReference"},{"id":719,"kind":1024,"name":"url","url":"interfaces/hyperlinkreference.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"HyperlinkReference"},{"id":720,"kind":256,"name":"IgnoreResponse","url":"interfaces/ignoreresponse.html","classes":"tsd-kind-interface"},{"id":721,"kind":1024,"name":"isIgnored","url":"interfaces/ignoreresponse.html#isignored","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IgnoreResponse"},{"id":722,"kind":1024,"name":"ignoreFlags","url":"interfaces/ignoreresponse.html#ignoreflags","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IgnoreResponse"},{"id":723,"kind":4,"name":"IgnoreStatus","url":"enums/ignorestatus.html","classes":"tsd-kind-enum"},{"id":724,"kind":16,"name":"NotIgnored","url":"enums/ignorestatus.html#notignored","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"IgnoreStatus"},{"id":725,"kind":16,"name":"IgnoredUser","url":"enums/ignorestatus.html#ignoreduser","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"IgnoreStatus"},{"id":726,"kind":16,"name":"IgnoredGroup","url":"enums/ignorestatus.html#ignoredgroup","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"IgnoreStatus"},{"id":727,"kind":16,"name":"IgnoredByGroup","url":"enums/ignorestatus.html#ignoredbygroup","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"IgnoreStatus"},{"id":728,"kind":16,"name":"IgnoredPost","url":"enums/ignorestatus.html#ignoredpost","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"IgnoreStatus"},{"id":729,"kind":16,"name":"IgnoredTag","url":"enums/ignorestatus.html#ignoredtag","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"IgnoreStatus"},{"id":730,"kind":16,"name":"IgnoredGlobal","url":"enums/ignorestatus.html#ignoredglobal","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"IgnoreStatus"},{"id":731,"kind":4,"name":"PartnershipType","url":"enums/partnershiptype.html","classes":"tsd-kind-enum"},{"id":732,"kind":16,"name":"None","url":"enums/partnershiptype.html#none","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PartnershipType"},{"id":733,"kind":16,"name":"Twitch","url":"enums/partnershiptype.html#twitch","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"PartnershipType"},{"id":734,"kind":256,"name":"TagResponse","url":"interfaces/tagresponse.html","classes":"tsd-kind-interface"},{"id":735,"kind":1024,"name":"tagText","url":"interfaces/tagresponse.html#tagtext","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TagResponse"},{"id":736,"kind":1024,"name":"ignoreStatus","url":"interfaces/tagresponse.html#ignorestatus","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TagResponse"},{"id":737,"kind":65536,"name":"__type","url":"interfaces/dictionarycomponentresponse.html#data.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DictionaryComponentResponse.data"},{"id":738,"kind":65536,"name":"__type","url":"interfaces/destinyfactiondefinition.html#tokenvalues.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyFactionDefinition.tokenValues"},{"id":739,"kind":65536,"name":"__type","url":"interfaces/destinyactivitymodedefinition.html#activitymodemappings.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyActivityModeDefinition.activityModeMappings"},{"id":740,"kind":65536,"name":"__type","url":"interfaces/destinyrecordtitleblock.html#titlesbygender.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyRecordTitleBlock.titlesByGender"},{"id":741,"kind":65536,"name":"__type","url":"interfaces/destinyrecordtitleblock.html#titlesbygenderhash.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyRecordTitleBlock.titlesByGenderHash"},{"id":742,"kind":65536,"name":"__type","url":"interfaces/destinyitemstatblockdefinition.html#stats.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyItemStatBlockDefinition.stats"},{"id":743,"kind":65536,"name":"__type","url":"interfaces/destinystatgroupdefinition.html#overrides.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyStatGroupDefinition.overrides"},{"id":744,"kind":65536,"name":"__type","url":"interfaces/destinyitemsourcedefinition.html#computedstats.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyItemSourceDefinition.computedStats"},{"id":745,"kind":65536,"name":"__type","url":"interfaces/destinytalentgriddefinition.html#groups.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyTalentGridDefinition.groups"},{"id":746,"kind":65536,"name":"__type","url":"interfaces/destinymanifest.html#mobileworldcontentpaths.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyManifest.mobileWorldContentPaths"},{"id":747,"kind":65536,"name":"__type","url":"interfaces/destinymanifest.html#jsonworldcontentpaths.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyManifest.jsonWorldContentPaths"},{"id":748,"kind":65536,"name":"__type","url":"interfaces/destinymanifest.html#mobilegearcdn.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyManifest.mobileGearCDN"},{"id":749,"kind":65536,"name":"__type","url":"interfaces/destinyprofileresponse.html#characteruninstanceditemcomponents.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyProfileResponse.characterUninstancedItemComponents"},{"id":750,"kind":65536,"name":"__type","url":"interfaces/destinykioskscomponent.html#kioskitems.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyKiosksComponent.kioskItems"},{"id":751,"kind":65536,"name":"__type","url":"interfaces/destinyplugsetscomponent.html#plugs.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyPlugSetsComponent.plugs"},{"id":752,"kind":65536,"name":"__type","url":"interfaces/destinyprofileprogressioncomponent.html#checklists.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyProfileProgressionComponent.checklists"},{"id":753,"kind":65536,"name":"__type","url":"interfaces/destinypresentationnodescomponent.html#nodes.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyPresentationNodesComponent.nodes"},{"id":754,"kind":65536,"name":"__type","url":"interfaces/destinyprofilerecordscomponent.html#records.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyProfileRecordsComponent.records"},{"id":755,"kind":65536,"name":"__type","url":"interfaces/destinyprofilecollectiblescomponent.html#collectibles.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyProfileCollectiblesComponent.collectibles"},{"id":756,"kind":65536,"name":"__type","url":"interfaces/destinycharactercomponent.html#stats.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyCharacterComponent.stats"},{"id":757,"kind":65536,"name":"__type","url":"interfaces/destinyracedefinition.html#genderedracenames.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyRaceDefinition.genderedRaceNames"},{"id":758,"kind":65536,"name":"__type","url":"interfaces/destinyracedefinition.html#genderedracenamesbygenderhash.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyRaceDefinition.genderedRaceNamesByGenderHash"},{"id":759,"kind":65536,"name":"__type","url":"interfaces/destinyclassdefinition.html#genderedclassnames.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyClassDefinition.genderedClassNames"},{"id":760,"kind":65536,"name":"__type","url":"interfaces/destinyclassdefinition.html#genderedclassnamesbygenderhash.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyClassDefinition.genderedClassNamesByGenderHash"},{"id":761,"kind":65536,"name":"__type","url":"interfaces/destinycharacterprogressioncomponent.html#progressions.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyCharacterProgressionComponent.progressions"},{"id":762,"kind":65536,"name":"__type","url":"interfaces/destinycharacterprogressioncomponent.html#factions.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyCharacterProgressionComponent.factions"},{"id":763,"kind":65536,"name":"__type","url":"interfaces/destinycharacterprogressioncomponent.html#milestones.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyCharacterProgressionComponent.milestones"},{"id":764,"kind":65536,"name":"__type","url":"interfaces/destinycharacterprogressioncomponent.html#uninstanceditemobjectives.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyCharacterProgressionComponent.uninstancedItemObjectives"},{"id":765,"kind":65536,"name":"__type","url":"interfaces/destinycharacterprogressioncomponent.html#checklists.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyCharacterProgressionComponent.checklists"},{"id":766,"kind":65536,"name":"__type","url":"interfaces/destinymilestone.html#values.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyMilestone.values"},{"id":767,"kind":65536,"name":"__type","url":"interfaces/destinymilestonedefinition.html#quests.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyMilestoneDefinition.quests"},{"id":768,"kind":65536,"name":"__type","url":"interfaces/destinymilestonedefinition.html#rewards.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyMilestoneDefinition.rewards"},{"id":769,"kind":65536,"name":"__type","url":"interfaces/destinymilestonedefinition.html#values.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyMilestoneDefinition.values"},{"id":770,"kind":65536,"name":"__type","url":"interfaces/destinymilestonequestdefinition.html#activities.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyMilestoneQuestDefinition.activities"},{"id":771,"kind":65536,"name":"__type","url":"interfaces/destinymilestoneactivitydefinition.html#variants.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyMilestoneActivityDefinition.variants"},{"id":772,"kind":65536,"name":"__type","url":"interfaces/destinymilestonerewardcategorydefinition.html#rewardentries.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyMilestoneRewardCategoryDefinition.rewardEntries"},{"id":773,"kind":65536,"name":"__type","url":"interfaces/destinymilestonechallengeactivity.html#booleanactivityoptions.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyMilestoneChallengeActivity.booleanActivityOptions"},{"id":774,"kind":65536,"name":"__type","url":"interfaces/destinycharacterrecordscomponent.html#records.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyCharacterRecordsComponent.records"},{"id":775,"kind":65536,"name":"__type","url":"interfaces/destinycollectiblescomponent.html#collectibles.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyCollectiblesComponent.collectibles"},{"id":776,"kind":65536,"name":"__type","url":"interfaces/destinyitemrendercomponent.html#artregions.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyItemRenderComponent.artRegions"},{"id":777,"kind":65536,"name":"__type","url":"interfaces/destinyitemstatscomponent.html#stats.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyItemStatsComponent.stats"},{"id":778,"kind":65536,"name":"__type","url":"interfaces/destinycurrenciescomponent.html#itemquantities.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyCurrenciesComponent.itemQuantities"},{"id":779,"kind":65536,"name":"__type","url":"interfaces/destinyvendorsresponse.html#itemcomponents.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyVendorsResponse.itemComponents"},{"id":780,"kind":65536,"name":"__type","url":"interfaces/personaldestinyvendorsaleitemsetcomponent.html#saleitems.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"PersonalDestinyVendorSaleItemSetComponent.saleItems"},{"id":781,"kind":65536,"name":"__type","url":"interfaces/publicdestinyvendorsaleitemsetcomponent.html#saleitems.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"PublicDestinyVendorSaleItemSetComponent.saleItems"},{"id":782,"kind":65536,"name":"__type","url":"interfaces/destinypostgamecarnagereportentry.html#values.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyPostGameCarnageReportEntry.values"},{"id":783,"kind":65536,"name":"__type","url":"interfaces/destinypostgamecarnagereportextendeddata.html#values.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyPostGameCarnageReportExtendedData.values"},{"id":784,"kind":65536,"name":"__type","url":"interfaces/destinyhistoricalweaponstats.html#values.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyHistoricalWeaponStats.values"},{"id":785,"kind":65536,"name":"__type","url":"interfaces/destinyreportreasoncategorydefinition.html#reasons.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyReportReasonCategoryDefinition.reasons"},{"id":786,"kind":65536,"name":"__type","url":"interfaces/destinyhistoricalstatsbyperiod.html#alltime.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyHistoricalStatsByPeriod.allTime"},{"id":787,"kind":65536,"name":"__type","url":"interfaces/destinyhistoricalstatsbyperiod.html#alltimetier1.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyHistoricalStatsByPeriod.allTimeTier1"},{"id":788,"kind":65536,"name":"__type","url":"interfaces/destinyhistoricalstatsbyperiod.html#alltimetier2.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyHistoricalStatsByPeriod.allTimeTier2"},{"id":789,"kind":65536,"name":"__type","url":"interfaces/destinyhistoricalstatsbyperiod.html#alltimetier3.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyHistoricalStatsByPeriod.allTimeTier3"},{"id":790,"kind":65536,"name":"__type","url":"interfaces/destinyhistoricalstatsperiodgroup.html#values.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyHistoricalStatsPeriodGroup.values"},{"id":791,"kind":65536,"name":"__type","url":"interfaces/destinyhistoricalstatswithmerged.html#results.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyHistoricalStatsWithMerged.results"},{"id":792,"kind":65536,"name":"__type","url":"interfaces/destinyhistoricalstatspercharacter.html#results.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyHistoricalStatsPerCharacter.results"},{"id":793,"kind":65536,"name":"__type","url":"interfaces/destinyaggregateactivitystats.html#values.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyAggregateActivityStats.values"},{"id":794,"kind":65536,"name":"__type","url":"interfaces/destinypublicmilestonechallengeactivity.html#booleanactivityoptions.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"DestinyPublicMilestoneChallengeActivity.booleanActivityOptions"},{"id":795,"kind":4,"name":"GlobalAlertLevel","url":"enums/globalalertlevel.html","classes":"tsd-kind-enum"},{"id":796,"kind":16,"name":"Unkown","url":"enums/globalalertlevel.html#unkown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"GlobalAlertLevel"},{"id":797,"kind":16,"name":"Blue","url":"enums/globalalertlevel.html#blue","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"GlobalAlertLevel"},{"id":798,"kind":16,"name":"Yellow","url":"enums/globalalertlevel.html#yellow","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"GlobalAlertLevel"},{"id":799,"kind":16,"name":"Red","url":"enums/globalalertlevel.html#red","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"GlobalAlertLevel"},{"id":800,"kind":4,"name":"GlobalAlertType","url":"enums/globalalerttype.html","classes":"tsd-kind-enum"},{"id":801,"kind":16,"name":"GlobalAlert","url":"enums/globalalerttype.html#globalalert","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"GlobalAlertType"},{"id":802,"kind":16,"name":"StreamingAlert","url":"enums/globalalerttype.html#streamingalert","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"GlobalAlertType"},{"id":803,"kind":4,"name":"StatId","url":"enums/statid.html","classes":"tsd-kind-enum"},{"id":804,"kind":16,"name":"ActivitiesClearedabilityKills","url":"enums/statid.html#activitiesclearedabilitykills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":805,"kind":16,"name":"ActivitiesEntered","url":"enums/statid.html#activitiesentered","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":806,"kind":16,"name":"ActivitiesWon","url":"enums/statid.html#activitieswon","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":807,"kind":16,"name":"Assists","url":"enums/statid.html#assists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":808,"kind":16,"name":"AverageDeathDistance","url":"enums/statid.html#averagedeathdistance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":809,"kind":16,"name":"AverageKillDistance","url":"enums/statid.html#averagekilldistance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":810,"kind":16,"name":"AverageLifespan","url":"enums/statid.html#averagelifespan","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":811,"kind":16,"name":"AverageScorePerKill","url":"enums/statid.html#averagescoreperkill","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":812,"kind":16,"name":"AverageScorePerLife","url":"enums/statid.html#averagescoreperlife","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":813,"kind":16,"name":"BestSingleGameKills","url":"enums/statid.html#bestsinglegamekills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":814,"kind":16,"name":"BestSingleGameScore","url":"enums/statid.html#bestsinglegamescore","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":815,"kind":16,"name":"Completed","url":"enums/statid.html#completed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":816,"kind":16,"name":"FastestCompletionMsForActivity","url":"enums/statid.html#fastestcompletionmsforactivity","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":817,"kind":16,"name":"ActivityCompletions","url":"enums/statid.html#activitycompletions","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":818,"kind":16,"name":"ActivityDeaths","url":"enums/statid.html#activitydeaths","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":819,"kind":16,"name":"ActivityKills","url":"enums/statid.html#activitykills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":820,"kind":16,"name":"ActivitySecondsPlayed","url":"enums/statid.html#activitysecondsplayed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":821,"kind":16,"name":"ActivityWins","url":"enums/statid.html#activitywins","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":822,"kind":16,"name":"ActivityGoalsMissed","url":"enums/statid.html#activitygoalsmissed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":823,"kind":16,"name":"ActivityCompletedFailures","url":"enums/statid.html#activitycompletedfailures","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":824,"kind":16,"name":"ActivitySpecialActions","url":"enums/statid.html#activityspecialactions","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":825,"kind":16,"name":"ActivityBestGoalsHit","url":"enums/statid.html#activitybestgoalshit","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":826,"kind":16,"name":"ActivitySpecialScore","url":"enums/statid.html#activityspecialscore","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":827,"kind":16,"name":"ActivityFastestObjectiveCompletionMs","url":"enums/statid.html#activityfastestobjectivecompletionms","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":828,"kind":16,"name":"ActivityBestSingleGameScore","url":"enums/statid.html#activitybestsinglegamescore","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":829,"kind":16,"name":"ActivityKillsDeathsRatio","url":"enums/statid.html#activitykillsdeathsratio","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":830,"kind":16,"name":"ActivityKillsDeathsAssists","url":"enums/statid.html#activitykillsdeathsassists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":831,"kind":16,"name":"Deaths","url":"enums/statid.html#deaths","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":832,"kind":16,"name":"Kills","url":"enums/statid.html#kills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":833,"kind":16,"name":"KillsDeathsRatio","url":"enums/statid.html#killsdeathsratio","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":834,"kind":16,"name":"KillsDeathsAssists","url":"enums/statid.html#killsdeathsassists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":835,"kind":16,"name":"LbSingleGameKills","url":"enums/statid.html#lbsinglegamekills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":836,"kind":16,"name":"LbPrecisionKills","url":"enums/statid.html#lbprecisionkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":837,"kind":16,"name":"LbAssists","url":"enums/statid.html#lbassists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":838,"kind":16,"name":"LbDeaths","url":"enums/statid.html#lbdeaths","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":839,"kind":16,"name":"LbKills","url":"enums/statid.html#lbkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":840,"kind":16,"name":"LbObjectivesCompleted","url":"enums/statid.html#lbobjectivescompleted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":841,"kind":16,"name":"LbSingleGameScore","url":"enums/statid.html#lbsinglegamescore","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":842,"kind":16,"name":"MaximumPowerLevel","url":"enums/statid.html#maximumpowerlevel","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":843,"kind":16,"name":"MedalAbilityDawnbladeAerial","url":"enums/statid.html#medalabilitydawnbladeaerial","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":844,"kind":16,"name":"MedalAbilityDawnbladeSlam","url":"enums/statid.html#medalabilitydawnbladeslam","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":845,"kind":16,"name":"MedalAbilityFlowwalkerMulti","url":"enums/statid.html#medalabilityflowwalkermulti","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":846,"kind":16,"name":"MedalAbilityFlowwalkerQuick","url":"enums/statid.html#medalabilityflowwalkerquick","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":847,"kind":16,"name":"MedalAbilityGunslingerMulti","url":"enums/statid.html#medalabilitygunslingermulti","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":848,"kind":16,"name":"MedalAbilityGunslingerQuick","url":"enums/statid.html#medalabilitygunslingerquick","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":849,"kind":16,"name":"MedalAbilityJuggernautCombo","url":"enums/statid.html#medalabilityjuggernautcombo","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":850,"kind":16,"name":"MedalAbilityJuggernautSlam","url":"enums/statid.html#medalabilityjuggernautslam","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":851,"kind":16,"name":"MedalAbilityNightstalkerLongRange","url":"enums/statid.html#medalabilitynightstalkerlongrange","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":852,"kind":16,"name":"MedalAbilityNightstalkerTetherQuick","url":"enums/statid.html#medalabilitynightstalkertetherquick","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":853,"kind":16,"name":"MedalAbilitySentinelCombo","url":"enums/statid.html#medalabilitysentinelcombo","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":854,"kind":16,"name":"MedalAbilitySentinelWard","url":"enums/statid.html#medalabilitysentinelward","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":855,"kind":16,"name":"MedalAbilityStormcallerLandfall","url":"enums/statid.html#medalabilitystormcallerlandfall","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":856,"kind":16,"name":"MedalAbilityStormcallerMulti","url":"enums/statid.html#medalabilitystormcallermulti","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":857,"kind":16,"name":"MedalAbilitySunbreakerLongRange","url":"enums/statid.html#medalabilitysunbreakerlongrange","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":858,"kind":16,"name":"MedalAbilitySunbreakerMulti","url":"enums/statid.html#medalabilitysunbreakermulti","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":859,"kind":16,"name":"MedalAbilityVoidwalkerDistance","url":"enums/statid.html#medalabilityvoidwalkerdistance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":860,"kind":16,"name":"MedalAbilityVoidwalkerVortex","url":"enums/statid.html#medalabilityvoidwalkervortex","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":861,"kind":16,"name":"MedalAvenger","url":"enums/statid.html#medalavenger","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":862,"kind":16,"name":"MedalControlAdvantageHold","url":"enums/statid.html#medalcontroladvantagehold","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":863,"kind":16,"name":"MedalControlAdvantageStreak","url":"enums/statid.html#medalcontroladvantagestreak","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":864,"kind":16,"name":"MedalControlCaptureAllZones","url":"enums/statid.html#medalcontrolcaptureallzones","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":865,"kind":16,"name":"MedalControlMostAdvantage","url":"enums/statid.html#medalcontrolmostadvantage","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":866,"kind":16,"name":"MedalControlPerimeterKill","url":"enums/statid.html#medalcontrolperimeterkill","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":867,"kind":16,"name":"MedalControlPowerPlayWipe","url":"enums/statid.html#medalcontrolpowerplaywipe","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":868,"kind":16,"name":"MedalCountdownDefense","url":"enums/statid.html#medalcountdowndefense","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":869,"kind":16,"name":"MedalCountdownDefusedLastStand","url":"enums/statid.html#medalcountdowndefusedlaststand","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":870,"kind":16,"name":"MedalCountdownDefusedMulti","url":"enums/statid.html#medalcountdowndefusedmulti","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":871,"kind":16,"name":"MedalCountdownDetonated","url":"enums/statid.html#medalcountdowndetonated","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":872,"kind":16,"name":"MedalCountdownPerfect","url":"enums/statid.html#medalcountdownperfect","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":873,"kind":16,"name":"MedalCountdownRoundAllAlive","url":"enums/statid.html#medalcountdownroundallalive","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":874,"kind":16,"name":"MedalCycle","url":"enums/statid.html#medalcycle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":875,"kind":16,"name":"MedalDefeatHunterDodge","url":"enums/statid.html#medaldefeathunterdodge","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":876,"kind":16,"name":"MedalDefeatTitanBrace","url":"enums/statid.html#medaldefeattitanbrace","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":877,"kind":16,"name":"MedalDefeatWarlockSigil","url":"enums/statid.html#medaldefeatwarlocksigil","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":878,"kind":16,"name":"MedalDefense","url":"enums/statid.html#medaldefense","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":879,"kind":16,"name":"MedalMatchBlowout","url":"enums/statid.html#medalmatchblowout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":880,"kind":16,"name":"MedalMatchComeback","url":"enums/statid.html#medalmatchcomeback","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":881,"kind":16,"name":"MedalMatchMostDamage","url":"enums/statid.html#medalmatchmostdamage","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":882,"kind":16,"name":"MedalMatchNeverTrailed","url":"enums/statid.html#medalmatchnevertrailed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":883,"kind":16,"name":"MedalMatchOvertime","url":"enums/statid.html#medalmatchovertime","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":884,"kind":16,"name":"MedalMatchUndefeated","url":"enums/statid.html#medalmatchundefeated","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":885,"kind":16,"name":"MedalMulti2x","url":"enums/statid.html#medalmulti2x","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":886,"kind":16,"name":"MedalMulti3x","url":"enums/statid.html#medalmulti3x","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":887,"kind":16,"name":"MedalMulti4x","url":"enums/statid.html#medalmulti4x","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":888,"kind":16,"name":"MedalMultiEntireTeam","url":"enums/statid.html#medalmultientireteam","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":889,"kind":16,"name":"MedalPayback","url":"enums/statid.html#medalpayback","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":890,"kind":16,"name":"MedalQuickStrike","url":"enums/statid.html#medalquickstrike","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":891,"kind":16,"name":"MedalStreak10x","url":"enums/statid.html#medalstreak10x","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":892,"kind":16,"name":"MedalStreak5x","url":"enums/statid.html#medalstreak5x","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":893,"kind":16,"name":"MedalStreakAbsurd","url":"enums/statid.html#medalstreakabsurd","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":894,"kind":16,"name":"MedalStreakCombined","url":"enums/statid.html#medalstreakcombined","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":895,"kind":16,"name":"MedalStreakShutdown","url":"enums/statid.html#medalstreakshutdown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":896,"kind":16,"name":"MedalStreakTeam","url":"enums/statid.html#medalstreakteam","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":897,"kind":16,"name":"MedalSuperShutdown","url":"enums/statid.html#medalsupershutdown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":898,"kind":16,"name":"MedalSupremacyCrestCreditStreak","url":"enums/statid.html#medalsupremacycrestcreditstreak","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":899,"kind":16,"name":"MedalSupremacyFirstCrest","url":"enums/statid.html#medalsupremacyfirstcrest","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":900,"kind":16,"name":"MedalSupremacyNeverCollected","url":"enums/statid.html#medalsupremacynevercollected","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":901,"kind":16,"name":"MedalSupremacyPerfectSecureRate","url":"enums/statid.html#medalsupremacyperfectsecurerate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":902,"kind":16,"name":"MedalSupremacyRecoverStreak","url":"enums/statid.html#medalsupremacyrecoverstreak","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":903,"kind":16,"name":"MedalSupremacySecureStreak","url":"enums/statid.html#medalsupremacysecurestreak","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":904,"kind":16,"name":"MedalSurvivalComeback","url":"enums/statid.html#medalsurvivalcomeback","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":905,"kind":16,"name":"MedalSurvivalKnockout","url":"enums/statid.html#medalsurvivalknockout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":906,"kind":16,"name":"MedalSurvivalQuickWipe","url":"enums/statid.html#medalsurvivalquickwipe","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":907,"kind":16,"name":"MedalSurvivalTeamUndefeated","url":"enums/statid.html#medalsurvivalteamundefeated","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":908,"kind":16,"name":"MedalSurvivalUndefeated","url":"enums/statid.html#medalsurvivalundefeated","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":909,"kind":16,"name":"MedalSurvivalWinLastStand","url":"enums/statid.html#medalsurvivalwinlaststand","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":910,"kind":16,"name":"MedalWeaponAuto","url":"enums/statid.html#medalweaponauto","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":911,"kind":16,"name":"MedalWeaponFusion","url":"enums/statid.html#medalweaponfusion","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":912,"kind":16,"name":"MedalWeaponGrenade","url":"enums/statid.html#medalweapongrenade","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":913,"kind":16,"name":"MedalWeaponHandCannon","url":"enums/statid.html#medalweaponhandcannon","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":914,"kind":16,"name":"MedalWeaponPulse","url":"enums/statid.html#medalweaponpulse","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":915,"kind":16,"name":"MedalWeaponRocket","url":"enums/statid.html#medalweaponrocket","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":916,"kind":16,"name":"MedalWeaponScout","url":"enums/statid.html#medalweaponscout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":917,"kind":16,"name":"MedalWeaponShotgun","url":"enums/statid.html#medalweaponshotgun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":918,"kind":16,"name":"MedalWeaponSidearm","url":"enums/statid.html#medalweaponsidearm","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":919,"kind":16,"name":"MedalWeaponSmg","url":"enums/statid.html#medalweaponsmg","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":920,"kind":16,"name":"MedalWeaponSniper","url":"enums/statid.html#medalweaponsniper","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":921,"kind":16,"name":"MedalWeaponSword","url":"enums/statid.html#medalweaponsword","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":922,"kind":16,"name":"MedalsUnknown","url":"enums/statid.html#medalsunknown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":923,"kind":16,"name":"AllMedalsScore","url":"enums/statid.html#allmedalsscore","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":924,"kind":16,"name":"AllMedalsEarned","url":"enums/statid.html#allmedalsearned","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":925,"kind":16,"name":"ObjectivesCompleted","url":"enums/statid.html#objectivescompleted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":926,"kind":16,"name":"PrecisionKills","url":"enums/statid.html#precisionkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":927,"kind":16,"name":"ResurrectionsPerformed","url":"enums/statid.html#resurrectionsperformed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":928,"kind":16,"name":"ResurrectionsReceived","url":"enums/statid.html#resurrectionsreceived","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":929,"kind":16,"name":"Score","url":"enums/statid.html#score","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":930,"kind":16,"name":"SecondsPlayed","url":"enums/statid.html#secondsplayed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":931,"kind":16,"name":"ActivityDurationSeconds","url":"enums/statid.html#activitydurationseconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":932,"kind":16,"name":"Standing","url":"enums/statid.html#standing","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":933,"kind":16,"name":"Suicides","url":"enums/statid.html#suicides","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":934,"kind":16,"name":"Team","url":"enums/statid.html#team","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":935,"kind":16,"name":"TotalDeathDistance","url":"enums/statid.html#totaldeathdistance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":936,"kind":16,"name":"TotalKillDistance","url":"enums/statid.html#totalkilldistance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":937,"kind":16,"name":"WeaponPrecisionKillsAutoRifle","url":"enums/statid.html#weaponprecisionkillsautorifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":938,"kind":16,"name":"WeaponPrecisionKillsFusionRifle","url":"enums/statid.html#weaponprecisionkillsfusionrifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":939,"kind":16,"name":"WeaponPrecisionKillsGrenade","url":"enums/statid.html#weaponprecisionkillsgrenade","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":940,"kind":16,"name":"WeaponPrecisionKillsHandCannon","url":"enums/statid.html#weaponprecisionkillshandcannon","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":941,"kind":16,"name":"WeaponPrecisionKillsMachinegun","url":"enums/statid.html#weaponprecisionkillsmachinegun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":942,"kind":16,"name":"WeaponPrecisionKillsMelee","url":"enums/statid.html#weaponprecisionkillsmelee","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":943,"kind":16,"name":"WeaponPrecisionKillsPulseRifle","url":"enums/statid.html#weaponprecisionkillspulserifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":944,"kind":16,"name":"WeaponPrecisionKillsRocketLauncher","url":"enums/statid.html#weaponprecisionkillsrocketlauncher","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":945,"kind":16,"name":"WeaponPrecisionKillsScoutRifle","url":"enums/statid.html#weaponprecisionkillsscoutrifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":946,"kind":16,"name":"WeaponPrecisionKillsShotgun","url":"enums/statid.html#weaponprecisionkillsshotgun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":947,"kind":16,"name":"WeaponPrecisionKillsSniper","url":"enums/statid.html#weaponprecisionkillssniper","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":948,"kind":16,"name":"WeaponPrecisionKillsSubmachinegun","url":"enums/statid.html#weaponprecisionkillssubmachinegun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":949,"kind":16,"name":"WeaponPrecisionKillsSuper","url":"enums/statid.html#weaponprecisionkillssuper","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":950,"kind":16,"name":"WeaponPrecisionKillsRelic","url":"enums/statid.html#weaponprecisionkillsrelic","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":951,"kind":16,"name":"WeaponPrecisionKillsSideArm","url":"enums/statid.html#weaponprecisionkillssidearm","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":952,"kind":16,"name":"WeaponKillsAutoRifle","url":"enums/statid.html#weaponkillsautorifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":953,"kind":16,"name":"WeaponKillsFusionRifle","url":"enums/statid.html#weaponkillsfusionrifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":954,"kind":16,"name":"WeaponKillsGrenade","url":"enums/statid.html#weaponkillsgrenade","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":955,"kind":16,"name":"WeaponKillsHandCannon","url":"enums/statid.html#weaponkillshandcannon","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":956,"kind":16,"name":"WeaponKillsMachinegun","url":"enums/statid.html#weaponkillsmachinegun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":957,"kind":16,"name":"WeaponKillsMelee","url":"enums/statid.html#weaponkillsmelee","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":958,"kind":16,"name":"WeaponKillsPulseRifle","url":"enums/statid.html#weaponkillspulserifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":959,"kind":16,"name":"WeaponKillsRocketLauncher","url":"enums/statid.html#weaponkillsrocketlauncher","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":960,"kind":16,"name":"WeaponKillsScoutRifle","url":"enums/statid.html#weaponkillsscoutrifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":961,"kind":16,"name":"WeaponKillsShotgun","url":"enums/statid.html#weaponkillsshotgun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":962,"kind":16,"name":"WeaponKillsSniper","url":"enums/statid.html#weaponkillssniper","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":963,"kind":16,"name":"WeaponKillsSubmachinegun","url":"enums/statid.html#weaponkillssubmachinegun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":964,"kind":16,"name":"WeaponKillsSuper","url":"enums/statid.html#weaponkillssuper","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":965,"kind":16,"name":"WeaponKillsRelic","url":"enums/statid.html#weaponkillsrelic","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":966,"kind":16,"name":"WeaponKillsSideArm","url":"enums/statid.html#weaponkillssidearm","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":967,"kind":16,"name":"WeaponKillsSword","url":"enums/statid.html#weaponkillssword","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":968,"kind":16,"name":"WeaponKillsAbility","url":"enums/statid.html#weaponkillsability","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":969,"kind":16,"name":"WeaponBestType","url":"enums/statid.html#weaponbesttype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":970,"kind":16,"name":"WeaponKillsPrecisionKillsAutoRifle","url":"enums/statid.html#weaponkillsprecisionkillsautorifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":971,"kind":16,"name":"WeaponKillsPrecisionKillsFusionRifle","url":"enums/statid.html#weaponkillsprecisionkillsfusionrifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":972,"kind":16,"name":"WeaponKillsPrecisionKillsGrenade","url":"enums/statid.html#weaponkillsprecisionkillsgrenade","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":973,"kind":16,"name":"WeaponKillsPrecisionKillsHandCannon","url":"enums/statid.html#weaponkillsprecisionkillshandcannon","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":974,"kind":16,"name":"WeaponKillsPrecisionKillsMachinegun","url":"enums/statid.html#weaponkillsprecisionkillsmachinegun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":975,"kind":16,"name":"WeaponKillsPrecisionKillsMelee","url":"enums/statid.html#weaponkillsprecisionkillsmelee","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":976,"kind":16,"name":"WeaponKillsPrecisionKillsPulseRifle","url":"enums/statid.html#weaponkillsprecisionkillspulserifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":977,"kind":16,"name":"WeaponKillsPrecisionKillsRocketLauncher","url":"enums/statid.html#weaponkillsprecisionkillsrocketlauncher","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":978,"kind":16,"name":"WeaponKillsPrecisionKillsScoutRifle","url":"enums/statid.html#weaponkillsprecisionkillsscoutrifle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":979,"kind":16,"name":"WeaponKillsPrecisionKillsShotgun","url":"enums/statid.html#weaponkillsprecisionkillsshotgun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":980,"kind":16,"name":"WeaponKillsPrecisionKillsSniper","url":"enums/statid.html#weaponkillsprecisionkillssniper","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":981,"kind":16,"name":"WeaponKillsPrecisionKillsSubmachinegun","url":"enums/statid.html#weaponkillsprecisionkillssubmachinegun","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":982,"kind":16,"name":"WeaponKillsPrecisionKillsSuper","url":"enums/statid.html#weaponkillsprecisionkillssuper","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":983,"kind":16,"name":"WeaponKillsPrecisionKillsRelic","url":"enums/statid.html#weaponkillsprecisionkillsrelic","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":984,"kind":16,"name":"WeaponKillsPrecisionKillsSideArm","url":"enums/statid.html#weaponkillsprecisionkillssidearm","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":985,"kind":16,"name":"WinLossRatio","url":"enums/statid.html#winlossratio","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":986,"kind":16,"name":"UniqueWeaponAssists","url":"enums/statid.html#uniqueweaponassists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":987,"kind":16,"name":"UniqueWeaponAssistDamage","url":"enums/statid.html#uniqueweaponassistdamage","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":988,"kind":16,"name":"UniqueWeaponKills","url":"enums/statid.html#uniqueweaponkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":989,"kind":16,"name":"UniqueWeaponPrecisionKills","url":"enums/statid.html#uniqueweaponprecisionkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":990,"kind":16,"name":"UniqueWeaponKillsPrecisionKills","url":"enums/statid.html#uniqueweaponkillsprecisionkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":991,"kind":16,"name":"AllParticipantsCount","url":"enums/statid.html#allparticipantscount","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":992,"kind":16,"name":"AllParticipantsScore","url":"enums/statid.html#allparticipantsscore","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":993,"kind":16,"name":"AllParticipantsTimePlayed","url":"enums/statid.html#allparticipantstimeplayed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":994,"kind":16,"name":"ActivityAssists","url":"enums/statid.html#activityassists","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":995,"kind":16,"name":"CompletionReason","url":"enums/statid.html#completionreason","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":996,"kind":16,"name":"FireteamId","url":"enums/statid.html#fireteamid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":997,"kind":16,"name":"LongestKillSpree","url":"enums/statid.html#longestkillspree","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":998,"kind":16,"name":"LongestSingleLife","url":"enums/statid.html#longestsinglelife","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":999,"kind":16,"name":"MostPrecisionKills","url":"enums/statid.html#mostprecisionkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1000,"kind":16,"name":"OrbsDropped","url":"enums/statid.html#orbsdropped","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1001,"kind":16,"name":"OrbsGathered","url":"enums/statid.html#orbsgathered","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1002,"kind":16,"name":"StartSeconds","url":"enums/statid.html#startseconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1003,"kind":16,"name":"TimePlayedSeconds","url":"enums/statid.html#timeplayedseconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1004,"kind":16,"name":"PlayerCount","url":"enums/statid.html#playercount","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1005,"kind":16,"name":"ActivityPrecisionKills","url":"enums/statid.html#activityprecisionkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1006,"kind":16,"name":"PublicEventsCompleted","url":"enums/statid.html#publiceventscompleted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1007,"kind":16,"name":"PublicEventsJoined","url":"enums/statid.html#publiceventsjoined","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1008,"kind":16,"name":"RemainingTimeAfterQuitSeconds","url":"enums/statid.html#remainingtimeafterquitseconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1009,"kind":16,"name":"TeamScore","url":"enums/statid.html#teamscore","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1010,"kind":16,"name":"TotalActivityDurationSeconds","url":"enums/statid.html#totalactivitydurationseconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1011,"kind":16,"name":"DailyMedalsEarned","url":"enums/statid.html#dailymedalsearned","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1012,"kind":16,"name":"CombatRating","url":"enums/statid.html#combatrating","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1013,"kind":16,"name":"LbMostPrecisionKills","url":"enums/statid.html#lbmostprecisionkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1014,"kind":16,"name":"LbLongestKillSpree","url":"enums/statid.html#lblongestkillspree","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1015,"kind":16,"name":"LbLongestKillDistance","url":"enums/statid.html#lblongestkilldistance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1016,"kind":16,"name":"LbFastestCompletionMs","url":"enums/statid.html#lbfastestcompletionms","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1017,"kind":16,"name":"LbLongestSingleLife","url":"enums/statid.html#lblongestsinglelife","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1018,"kind":16,"name":"FastestCompletionMs","url":"enums/statid.html#fastestcompletionms","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1019,"kind":16,"name":"LongestKillDistance","url":"enums/statid.html#longestkilldistance","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1020,"kind":16,"name":"HighestCharacterLevel","url":"enums/statid.html#highestcharacterlevel","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1021,"kind":16,"name":"HighestLightLevel","url":"enums/statid.html#highestlightlevel","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1022,"kind":16,"name":"HighestSandboxLevel","url":"enums/statid.html#highestsandboxlevel","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1023,"kind":16,"name":"SparksCaptured","url":"enums/statid.html#sparkscaptured","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1024,"kind":16,"name":"SlamDunks","url":"enums/statid.html#slamdunks","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1025,"kind":16,"name":"StyleDunks","url":"enums/statid.html#styledunks","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1026,"kind":16,"name":"DunkKills","url":"enums/statid.html#dunkkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1027,"kind":16,"name":"CarrierKills","url":"enums/statid.html#carrierkills","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1028,"kind":16,"name":"ActivityGatesHit","url":"enums/statid.html#activitygateshit","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1029,"kind":16,"name":"RaceCompletionSeconds","url":"enums/statid.html#racecompletionseconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1030,"kind":16,"name":"GatesHit","url":"enums/statid.html#gateshit","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1031,"kind":16,"name":"RaceCompletionMilliseconds","url":"enums/statid.html#racecompletionmilliseconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"StatId"},{"id":1032,"kind":4,"name":"TypeDefinition","url":"enums/typedefinition.html","classes":"tsd-kind-enum"},{"id":1033,"kind":16,"name":"DestinyActivityGraphDefinition","url":"enums/typedefinition.html#destinyactivitygraphdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1034,"kind":16,"name":"DestinyActivityModeDefinition","url":"enums/typedefinition.html#destinyactivitymodedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1035,"kind":16,"name":"DestinyActivityModifierDefinition","url":"enums/typedefinition.html#destinyactivitymodifierdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1036,"kind":16,"name":"DestinyActivityTypeDefinition","url":"enums/typedefinition.html#destinyactivitytypedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1037,"kind":16,"name":"DestinyBondDefinition","url":"enums/typedefinition.html#destinybonddefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1038,"kind":16,"name":"DestinyClassDefinition","url":"enums/typedefinition.html#destinyclassdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1039,"kind":16,"name":"DestinyDamageTypeDefinition","url":"enums/typedefinition.html#destinydamagetypedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1040,"kind":16,"name":"DestinyDestinationDefinition","url":"enums/typedefinition.html#destinydestinationdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1041,"kind":16,"name":"DestinyEnemyRaceDefinition","url":"enums/typedefinition.html#destinyenemyracedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1042,"kind":16,"name":"DestinyFactionDefinition","url":"enums/typedefinition.html#destinyfactiondefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1043,"kind":16,"name":"DestinyGenderDefinition","url":"enums/typedefinition.html#destinygenderdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1044,"kind":16,"name":"DestinyHistoricalStatsDefinition","url":"enums/typedefinition.html#destinyhistoricalstatsdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1045,"kind":16,"name":"DestinyInventoryBucketDefinition","url":"enums/typedefinition.html#destinyinventorybucketdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1046,"kind":16,"name":"DestinyInventoryItemDefinition","url":"enums/typedefinition.html#destinyinventoryitemdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1047,"kind":16,"name":"DestinyItemCategoryDefinition","url":"enums/typedefinition.html#destinyitemcategorydefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1048,"kind":16,"name":"DestinyItemTierTypeDefinition","url":"enums/typedefinition.html#destinyitemtiertypedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1049,"kind":16,"name":"DestinyLocationDefinition","url":"enums/typedefinition.html#destinylocationdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1050,"kind":16,"name":"DestinyLoreDefinition","url":"enums/typedefinition.html#destinyloredefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1051,"kind":16,"name":"DestinyMedalTierDefinition","url":"enums/typedefinition.html#destinymedaltierdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1052,"kind":16,"name":"DestinyMilestoneDefinition","url":"enums/typedefinition.html#destinymilestonedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1053,"kind":16,"name":"DestinyObjectiveDefinition","url":"enums/typedefinition.html#destinyobjectivedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1054,"kind":16,"name":"DestinyPlaceDefinition","url":"enums/typedefinition.html#destinyplacedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1055,"kind":16,"name":"DestinyProgressionDefinition","url":"enums/typedefinition.html#destinyprogressiondefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1056,"kind":16,"name":"DestinyProgressionLevelRequirementDefinition","url":"enums/typedefinition.html#destinyprogressionlevelrequirementdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1057,"kind":16,"name":"DestinyRaceDefinition","url":"enums/typedefinition.html#destinyracedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1058,"kind":16,"name":"DestinyRewardSourceDefinition","url":"enums/typedefinition.html#destinyrewardsourcedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1059,"kind":16,"name":"DestinySackRewardItemListDefinition","url":"enums/typedefinition.html#destinysackrewarditemlistdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1060,"kind":16,"name":"DestinySandboxPerkDefinition","url":"enums/typedefinition.html#destinysandboxperkdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1061,"kind":16,"name":"DestinySocketCategoryDefinition","url":"enums/typedefinition.html#destinysocketcategorydefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1062,"kind":16,"name":"DestinySocketTypeDefinition","url":"enums/typedefinition.html#destinysockettypedefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1063,"kind":16,"name":"DestinyStatDefinition","url":"enums/typedefinition.html#destinystatdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1064,"kind":16,"name":"DestinyStatGroupDefinition","url":"enums/typedefinition.html#destinystatgroupdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1065,"kind":16,"name":"DestinyTalentGridDefinition","url":"enums/typedefinition.html#destinytalentgriddefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1066,"kind":16,"name":"DestinyUnlockDefinition","url":"enums/typedefinition.html#destinyunlockdefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1067,"kind":16,"name":"DestinyVendorCategoryDefinition","url":"enums/typedefinition.html#destinyvendorcategorydefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1068,"kind":16,"name":"DestinyVendorDefinition","url":"enums/typedefinition.html#destinyvendordefinition","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TypeDefinition"},{"id":1069,"kind":256,"name":"TravelerConfig","url":"interfaces/travelerconfig.html","classes":"tsd-kind-interface"},{"id":1070,"kind":1024,"name":"apikey","url":"interfaces/travelerconfig.html#apikey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TravelerConfig"},{"id":1071,"kind":1024,"name":"userAgent","url":"interfaces/travelerconfig.html#useragent","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TravelerConfig"},{"id":1072,"kind":1024,"name":"oauthClientId","url":"interfaces/travelerconfig.html#oauthclientid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TravelerConfig"},{"id":1073,"kind":1024,"name":"oauthClientSecret","url":"interfaces/travelerconfig.html#oauthclientsecret","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TravelerConfig"},{"id":1074,"kind":1024,"name":"debug","url":"interfaces/travelerconfig.html#debug","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TravelerConfig"},{"id":1075,"kind":256,"name":"StreamInfo","url":"interfaces/streaminfo.html","classes":"tsd-kind-interface"},{"id":1076,"kind":1024,"name":"ChannelName","url":"interfaces/streaminfo.html#channelname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"StreamInfo"},{"id":1077,"kind":256,"name":"GlobalAlert","url":"interfaces/globalalert.html","classes":"tsd-kind-interface"},{"id":1078,"kind":1024,"name":"AlertKey","url":"interfaces/globalalert.html#alertkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GlobalAlert"},{"id":1079,"kind":1024,"name":"AlertHtml","url":"interfaces/globalalert.html#alerthtml","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GlobalAlert"},{"id":1080,"kind":1024,"name":"AlerTimestamp","url":"interfaces/globalalert.html#alertimestamp","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GlobalAlert"},{"id":1081,"kind":1024,"name":"AlertLink","url":"interfaces/globalalert.html#alertlink","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GlobalAlert"},{"id":1082,"kind":1024,"name":"AlertLevel","url":"interfaces/globalalert.html#alertlevel","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GlobalAlert"},{"id":1083,"kind":1024,"name":"AlertType","url":"interfaces/globalalert.html#alerttype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GlobalAlert"},{"id":1084,"kind":1024,"name":"StreamInfo","url":"interfaces/globalalert.html#streaminfo","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GlobalAlert"},{"id":1085,"kind":256,"name":"DictionaryResponse","url":"interfaces/dictionaryresponse.html","classes":"tsd-kind-interface tsd-has-type-parameter"},{"id":1086,"kind":256,"name":"QueryStringParameters","url":"interfaces/querystringparameters.html","classes":"tsd-kind-interface"},{"id":1087,"kind":1024,"name":"components","url":"interfaces/querystringparameters.html#components","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"QueryStringParameters"},{"id":1088,"kind":1024,"name":"modes","url":"interfaces/querystringparameters.html#modes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"QueryStringParameters"},{"id":1089,"kind":1024,"name":"mode","url":"interfaces/querystringparameters.html#mode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"QueryStringParameters"},{"id":1090,"kind":1024,"name":"maxtop","url":"interfaces/querystringparameters.html#maxtop","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"QueryStringParameters"},{"id":1091,"kind":1024,"name":"statid","url":"interfaces/querystringparameters.html#statid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"QueryStringParameters"},{"id":1092,"kind":1024,"name":"page","url":"interfaces/querystringparameters.html#page","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"QueryStringParameters"},{"id":1093,"kind":1024,"name":"dayend","url":"interfaces/querystringparameters.html#dayend","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"QueryStringParameters"},{"id":1094,"kind":1024,"name":"daystart","url":"interfaces/querystringparameters.html#daystart","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"QueryStringParameters"},{"id":1095,"kind":1024,"name":"groups","url":"interfaces/querystringparameters.html#groups","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"QueryStringParameters"},{"id":1096,"kind":1024,"name":"periodType","url":"interfaces/querystringparameters.html#periodtype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"QueryStringParameters"},{"id":1097,"kind":1024,"name":"count","url":"interfaces/querystringparameters.html#count","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"QueryStringParameters"},{"id":1098,"kind":256,"name":"OAuthResponse","url":"interfaces/oauthresponse.html","classes":"tsd-kind-interface"},{"id":1099,"kind":1024,"name":"access_token","url":"interfaces/oauthresponse.html#access_token","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OAuthResponse"},{"id":1100,"kind":1024,"name":"token_type","url":"interfaces/oauthresponse.html#token_type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OAuthResponse"},{"id":1101,"kind":1024,"name":"expires_in","url":"interfaces/oauthresponse.html#expires_in","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OAuthResponse"},{"id":1102,"kind":1024,"name":"refresh_token","url":"interfaces/oauthresponse.html#refresh_token","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OAuthResponse"},{"id":1103,"kind":1024,"name":"refresh_expires_in","url":"interfaces/oauthresponse.html#refresh_expires_in","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OAuthResponse"},{"id":1104,"kind":1024,"name":"membership_id","url":"interfaces/oauthresponse.html#membership_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OAuthResponse"},{"id":1105,"kind":128,"name":"Destiny2Resource","url":"classes/destiny2resource.html","classes":"tsd-kind-class"},{"id":1106,"kind":1024,"name":"resourcePath","url":"classes/destiny2resource.html#resourcepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"Destiny2Resource"},{"id":1107,"kind":512,"name":"constructor","url":"classes/destiny2resource.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"Destiny2Resource"},{"id":1108,"kind":2048,"name":"getDestinyManifest","url":"classes/destiny2resource.html#getdestinymanifest","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1109,"kind":2048,"name":"getDestinyEntityDefinition","url":"classes/destiny2resource.html#getdestinyentitydefinition","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1110,"kind":2048,"name":"searchDestinyPlayer","url":"classes/destiny2resource.html#searchdestinyplayer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1111,"kind":2048,"name":"getLinkedProfiles","url":"classes/destiny2resource.html#getlinkedprofiles","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1112,"kind":2048,"name":"getProfile","url":"classes/destiny2resource.html#getprofile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1113,"kind":2048,"name":"getCharacter","url":"classes/destiny2resource.html#getcharacter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1114,"kind":2048,"name":"getClanWeeklyRewardState","url":"classes/destiny2resource.html#getclanweeklyrewardstate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1115,"kind":2048,"name":"getItem","url":"classes/destiny2resource.html#getitem","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1116,"kind":2048,"name":"getVendors","url":"classes/destiny2resource.html#getvendors","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1117,"kind":2048,"name":"getPublicVendors","url":"classes/destiny2resource.html#getpublicvendors","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1118,"kind":2048,"name":"getVendor","url":"classes/destiny2resource.html#getvendor","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1119,"kind":2048,"name":"getCollectibleNodeDetails","url":"classes/destiny2resource.html#getcollectiblenodedetails","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1120,"kind":2048,"name":"getPostGameCarnageReport","url":"classes/destiny2resource.html#getpostgamecarnagereport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1121,"kind":2048,"name":"getHistoricalStatsDefinition","url":"classes/destiny2resource.html#gethistoricalstatsdefinition","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1122,"kind":2048,"name":"getClanLeaderboards","url":"classes/destiny2resource.html#getclanleaderboards","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1123,"kind":2048,"name":"getClanAggregateStats","url":"classes/destiny2resource.html#getclanaggregatestats","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1124,"kind":2048,"name":"getLeaderboards","url":"classes/destiny2resource.html#getleaderboards","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1125,"kind":2048,"name":"getLeaderboardsForCharacter","url":"classes/destiny2resource.html#getleaderboardsforcharacter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1126,"kind":2048,"name":"searchDestinyEntities","url":"classes/destiny2resource.html#searchdestinyentities","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1127,"kind":2048,"name":"getHistoricalStats","url":"classes/destiny2resource.html#gethistoricalstats","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1128,"kind":2048,"name":"getHistoricalStatsForAccount","url":"classes/destiny2resource.html#gethistoricalstatsforaccount","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1129,"kind":2048,"name":"getActivityHistory","url":"classes/destiny2resource.html#getactivityhistory","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1130,"kind":2048,"name":"getUniqueWeaponHistory","url":"classes/destiny2resource.html#getuniqueweaponhistory","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1131,"kind":2048,"name":"getDestinyAggregateActivityStats","url":"classes/destiny2resource.html#getdestinyaggregateactivitystats","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1132,"kind":2048,"name":"getPublicMilestoneContent","url":"classes/destiny2resource.html#getpublicmilestonecontent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1133,"kind":2048,"name":"getPublicMilestones","url":"classes/destiny2resource.html#getpublicmilestones","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1134,"kind":2048,"name":"downloadManifest","url":"classes/destiny2resource.html#downloadmanifest","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1135,"kind":2048,"name":"downloadManifestJSON","url":"classes/destiny2resource.html#downloadmanifestjson","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destiny2Resource"},{"id":1136,"kind":1024,"name":"httpService","url":"classes/destiny2resource.html#httpservice","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"Destiny2Resource"},{"id":1137,"kind":1024,"name":"basePath","url":"classes/destiny2resource.html#basepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"Destiny2Resource"},{"id":1138,"kind":128,"name":"GlobalResource","url":"classes/globalresource.html","classes":"tsd-kind-class"},{"id":1139,"kind":1024,"name":"resourcePath","url":"classes/globalresource.html#resourcepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"GlobalResource"},{"id":1140,"kind":512,"name":"constructor","url":"classes/globalresource.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"GlobalResource"},{"id":1141,"kind":2048,"name":"getAvailableLocales","url":"classes/globalresource.html#getavailablelocales","classes":"tsd-kind-method tsd-parent-kind-class","parent":"GlobalResource"},{"id":1142,"kind":2048,"name":"getCommonSettings","url":"classes/globalresource.html#getcommonsettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"GlobalResource"},{"id":1143,"kind":2048,"name":"getGlobalAlerts","url":"classes/globalresource.html#getglobalalerts","classes":"tsd-kind-method tsd-parent-kind-class","parent":"GlobalResource"},{"id":1144,"kind":1024,"name":"httpService","url":"classes/globalresource.html#httpservice","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"GlobalResource"},{"id":1145,"kind":1024,"name":"basePath","url":"classes/globalresource.html#basepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"GlobalResource"},{"id":1146,"kind":128,"name":"OAuthResource","url":"classes/oauthresource.html","classes":"tsd-kind-class"},{"id":1147,"kind":1024,"name":"resourcePath","url":"classes/oauthresource.html#resourcepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"OAuthResource"},{"id":1148,"kind":1024,"name":"userAgent","url":"classes/oauthresource.html#useragent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"OAuthResource"},{"id":1149,"kind":512,"name":"constructor","url":"classes/oauthresource.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"OAuthResource"},{"id":1150,"kind":2048,"name":"generateOAuthURL","url":"classes/oauthresource.html#generateoauthurl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuthResource"},{"id":1151,"kind":2048,"name":"getAccessToken","url":"classes/oauthresource.html#getaccesstoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuthResource"},{"id":1152,"kind":2048,"name":"refreshToken","url":"classes/oauthresource.html#refreshtoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuthResource"},{"id":1153,"kind":1024,"name":"httpService","url":"classes/oauthresource.html#httpservice","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"OAuthResource"},{"id":1154,"kind":1024,"name":"basePath","url":"classes/oauthresource.html#basepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"OAuthResource"},{"id":1155,"kind":128,"name":"UserResource","url":"classes/userresource.html","classes":"tsd-kind-class"},{"id":1156,"kind":1024,"name":"resourcePath","url":"classes/userresource.html#resourcepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"UserResource"},{"id":1157,"kind":512,"name":"constructor","url":"classes/userresource.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"UserResource"},{"id":1158,"kind":2048,"name":"getMembershipDataForCurrentUser","url":"classes/userresource.html#getmembershipdataforcurrentuser","classes":"tsd-kind-method tsd-parent-kind-class","parent":"UserResource"},{"id":1159,"kind":2048,"name":"getMembershipDataById","url":"classes/userresource.html#getmembershipdatabyid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"UserResource"},{"id":1160,"kind":1024,"name":"httpService","url":"classes/userresource.html#httpservice","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"UserResource"},{"id":1161,"kind":1024,"name":"basePath","url":"classes/userresource.html#basepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"UserResource"},{"id":1162,"kind":65536,"name":"__type","url":"interfaces/contenttypedescription.html#tagmetadataitems.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"ContentTypeDescription.tagMetadataItems"},{"id":1163,"kind":65536,"name":"__type","url":"interfaces/contenttypeproperty.html#attributes.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"ContentTypeProperty.attributes"},{"id":1164,"kind":65536,"name":"__type","url":"interfaces/contenttypeproperty.html#representationselection.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"ContentTypeProperty.representationSelection"},{"id":1165,"kind":65536,"name":"__type","url":"interfaces/contentitempubliccontract.html#properties.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"ContentItemPublicContract.properties"},{"id":1166,"kind":65536,"name":"__type","url":"interfaces/groupresponse.html#currentusermembermap.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"GroupResponse.currentUserMemberMap"},{"id":1167,"kind":65536,"name":"__type","url":"interfaces/groupresponse.html#currentuserpotentialmembermap.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"GroupResponse.currentUserPotentialMemberMap"},{"id":1168,"kind":65536,"name":"__type","url":"interfaces/groupv2claninfoandinvestment.html#d2clanprogressions.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"GroupV2ClanInfoAndInvestment.d2ClanProgressions"},{"id":1169,"kind":32,"name":"App","url":"globals.html#app","classes":"tsd-kind-variable"},{"id":1170,"kind":32,"name":"User","url":"globals.html#user","classes":"tsd-kind-variable"},{"id":1171,"kind":32,"name":"Content","url":"globals.html#content","classes":"tsd-kind-variable"},{"id":1172,"kind":32,"name":"Forum","url":"globals.html#forum","classes":"tsd-kind-variable"},{"id":1173,"kind":32,"name":"Destiny2","url":"globals.html#destiny2","classes":"tsd-kind-variable"},{"id":1174,"kind":32,"name":"CommunityContent","url":"globals.html#communitycontent","classes":"tsd-kind-variable"},{"id":1175,"kind":32,"name":"Trending","url":"globals.html#trending","classes":"tsd-kind-variable"},{"id":1176,"kind":32,"name":"Fireteam","url":"globals.html#fireteam","classes":"tsd-kind-variable"}]}; \ No newline at end of file diff --git a/docs/classes/bungieresource.html b/docs/classes/bungieresource.html index e49d35f..34d95f6 100644 --- a/docs/classes/bungieresource.html +++ b/docs/classes/bungieresource.html @@ -121,7 +121,7 @@

constructor

  • Parameters

    @@ -143,7 +143,7 @@

    Protected basePath

    basePath: string
    @@ -153,7 +153,7 @@

    Protected httpServicehttpService: HTTPService @@ -163,7 +163,7 @@

    Protected resourcePathresourcePath: string diff --git a/docs/classes/destiny2resource.html b/docs/classes/destiny2resource.html index 4b45fa6..975516f 100644 --- a/docs/classes/destiny2resource.html +++ b/docs/classes/destiny2resource.html @@ -122,6 +122,7 @@

    Methods

  • getProfile
  • getPublicMilestoneContent
  • getPublicMilestones
  • +
  • getPublicVendors
  • getUniqueWeaponHistory
  • getVendor
  • getVendors
  • @@ -145,7 +146,7 @@

    constructor

    Parameters

    @@ -168,7 +169,7 @@

    Protected basePath

    @@ -179,7 +180,7 @@

    Protected httpService

    Inherited from BungieResource.httpService

    @@ -190,7 +191,7 @@

    Protected resourcePath

    Overrides BungieResource.resourcePath

    @@ -207,7 +208,7 @@

    downloadManifest

  • @@ -269,7 +270,7 @@

    downloadManifestJSON

  • @@ -325,13 +326,13 @@

    Returns Promise

    getActivityHistory

    @@ -413,13 +414,13 @@

    Returns Promise

    getCharacter

    @@ -505,13 +506,13 @@

    Returns Promise

    getClanAggregateStats

    @@ -570,13 +571,13 @@

    Returns Promise

    getClanLeaderboards

    @@ -643,13 +644,13 @@

    Returns Promise

    getClanWeeklyRewardState

    -

    Returns Promise<IServerResponse<IDestinyMilestone>>

    +

    Returns Promise<ServerResponse<DestinyMilestone>>

    When fulfilled returns an object containing information about the weekly clan results

  • @@ -695,13 +696,13 @@

    Returns Promise

    getCollectibleNodeDetails

    @@ -788,13 +789,13 @@

    Returns Promise

    getDestinyAggregateActivityStats

    -

    Returns Promise<IServerResponse<IDestinyAggregateActivityResults>>

    +

    Returns Promise<ServerResponse<DestinyAggregateActivityResults>>

    @@ -858,13 +859,13 @@

    Returns Promise

    getDestinyEntityDefinition

    -

    Returns Promise<IServerResponse<IDestinyDefinition>>

    +

    Returns Promise<ServerResponse<DestinyDefinition>>

    @@ -915,13 +916,13 @@

    Returns Promise

    getDestinyManifest

    @@ -958,13 +959,13 @@

    Returns Promise

    getHistoricalStats

    @@ -1054,13 +1055,13 @@

    Returns Promise

    getHistoricalStatsDefinition

    @@ -1491,13 +1492,13 @@

    Returns Promise

    getPostGameCarnageReport

    -

    Returns Promise<IServerResponse<IDestinyPostGameCarnageReportData>>

    +

    Returns Promise<ServerResponse<DestinyPostGameCarnageReportData>>

    When fulfilled returns an object containing the carnage report for the specified activity

    @@ -1543,13 +1544,13 @@

    Returns Promise

    getProfile

    @@ -1620,13 +1621,13 @@

    Returns Promise

    getPublicMilestoneContent

    -

    Returns Promise<IServerResponse<IDestinyMilestoneContent>>

    +

    Returns Promise<ServerResponse<DestinyMilestoneContent>>

    @@ -1673,13 +1674,13 @@

    Returns Promise

    getPublicMilestones

    + +
    + +

    getPublicVendors

    + +
      +
    • + +
      +
      +

      Get items available from vendors where the vendors have items for sale that are common for everyone. + If any portion of the Vendor's available inventory is character or account specific, we will be unable to return their data from this endpoint due to the way that available inventory is computed. + As I am often guilty of saying: 'It's a long story...'

      +
      +
      import Traveler from './Traveler';
      +import { BungieMembershipType } from 'the-traveler/type-definitions/app';
      +import { DestinyComponentType } from 'the-traveler/type-definitions/destiny2';
      +
      +let traveler = new Traveler({
      + apikey: 'apikey',
      + userAgent: 'useragent', //used to identify your request to the API
      +});
      +
      +traveler.destiny2
      +.getPublicVendors(
      +   {
      +     components: [DestinyComponentType.Vendors]
      +   }
      +)
      +.then(response => {
      +   console.log(response);
      +})
      +.catch(err => {
      +   console.log(err);
      +});
      +
      +
      memberof
      +

      Destiny2Resource

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        queryStringParameters: QueryStringParameters
        +
        +

        An object containing key/value query parameters for this endpoint. Following keys are valid:

        + You must request at least one component to receive results. +
        +
      • +
      +

      Returns Promise<ServerResponse<DestinyVendorsResponse>>

      +

      When fulfilled returns an object containing all valid components for the public Vendors endpoint

    @@ -1715,13 +1779,13 @@

    Returns Promise

    getUniqueWeaponHistory

    -

    Returns Promise<IServerResponse<IDestinyHistoricalWeaponStatsData>>

    +

    Returns Promise<ServerResponse<DestinyHistoricalWeaponStatsData>>

    @@ -1785,13 +1849,13 @@

    Returns Promise

    getVendor

    @@ -1879,13 +1943,13 @@

    Returns Promise

    getVendors

    @@ -1968,13 +2032,13 @@

    Returns Promise

    searchDestinyEntities

    @@ -2039,13 +2103,13 @@

    Returns Promise

    searchDestinyPlayer

    -

    Returns Promise<IServerResponse<IUserInfoCard[]>>

    +

    Returns Promise<ServerResponse<UserInfoCard[]>>

    @@ -2193,6 +2257,9 @@

    Returns Promise getPublicMilestones +
  • + getPublicVendors +
  • getUniqueWeaponHistory
  • diff --git a/docs/classes/globalresource.html b/docs/classes/globalresource.html index f1f5ce1..7ca949e 100644 --- a/docs/classes/globalresource.html +++ b/docs/classes/globalresource.html @@ -121,7 +121,7 @@

    constructor

    Parameters

    @@ -144,7 +144,7 @@

    Protected basePath

    @@ -155,7 +155,7 @@

    Protected httpService

    Inherited from BungieResource.httpService

    @@ -166,7 +166,7 @@

    Protected resourcePath

    Overrides BungieResource.resourcePath

    @@ -177,13 +177,13 @@

    Methods

    getAvailableLocales

    @@ -204,13 +204,13 @@

    Returns Promise

    getCommonSettings

    @@ -231,13 +231,13 @@

    Returns Promise

    getGlobalAlerts

    diff --git a/docs/classes/httpservice.html b/docs/classes/httpservice.html index bceccc4..e7acca9 100644 --- a/docs/classes/httpservice.html +++ b/docs/classes/httpservice.html @@ -120,7 +120,7 @@

    constructor

  • Parameters

    @@ -145,7 +145,7 @@

    Private debug: boolean @@ -155,7 +155,7 @@

    Private options

    options: GotJSONOptions
    @@ -172,7 +172,7 @@

    get

  • @@ -211,7 +211,7 @@

    post

  • Parameters

    diff --git a/docs/classes/logger.html b/docs/classes/logger.html index e13a65d..6428bdb 100644 --- a/docs/classes/logger.html +++ b/docs/classes/logger.html @@ -102,7 +102,7 @@

    Static debug

  • Parameters

    @@ -125,7 +125,7 @@

    Static err

  • Parameters

    @@ -148,7 +148,7 @@

    Static trace

  • Parameters

    @@ -171,7 +171,7 @@

    Static warn

  • Parameters

    diff --git a/docs/classes/oautherror.html b/docs/classes/oautherror.html index d532d6f..99851b7 100644 --- a/docs/classes/oautherror.html +++ b/docs/classes/oautherror.html @@ -83,37 +83,37 @@

    Hierarchy

    Index

    -
    +

    Constructors

    -
    +

    Properties

    -
    +

    Constructors

    -
    +

    constructor

    -
    @@ -276,13 +276,13 @@

    Returns Promise

    refreshToken

      -
    • refreshToken(refreshToken: string, oauthClientId: string, oauthClientSecret: string): Promise<IOAuthResponse>
    • +
    • refreshToken(refreshToken: string, oauthClientId: string, oauthClientSecret: string): Promise<OAuthResponse>
    -

    Returns Promise<IOAuthResponse>

    +

    Returns Promise<OAuthResponse>

  • diff --git a/docs/classes/userresource.html b/docs/classes/userresource.html index 05e0351..e877fc2 100644 --- a/docs/classes/userresource.html +++ b/docs/classes/userresource.html @@ -120,7 +120,7 @@

    constructor

    Parameters

    @@ -143,7 +143,7 @@

    Protected basePath

    @@ -154,7 +154,7 @@

    Protected httpService

    Inherited from BungieResource.httpService

    @@ -165,7 +165,7 @@

    Protected resourcePath

    Overrides BungieResource.resourcePath

    @@ -176,13 +176,13 @@

    Methods

    getMembershipDataById

    -

    Returns Promise<IServerResponse<IUserMembershipData>>

    +

    Returns Promise<ServerResponse<UserMembershipData>>

  • @@ -224,13 +224,13 @@

    Returns Promise

    getMembershipDataForCurrentUser

    -

    Returns Promise<IServerResponse<IUserMembershipData>>

    +

    Returns Promise<ServerResponse<UserMembershipData>>

    diff --git a/docs/enums/activitygraphnodehighlighttype.html b/docs/enums/activitygraphnodehighlighttype.html index cf62606..dac2d1d 100644 --- a/docs/enums/activitygraphnodehighlighttype.html +++ b/docs/enums/activitygraphnodehighlighttype.html @@ -66,6 +66,17 @@

    Enumeration ActivityGraphNodeHighlightType

    +
    +
    +
    +

    The various known UI styles in which an item can be highlighted. It'll be up to + you to determine what you want to show based on this highlighting, BNet doesn't + have any assets that correspond to these states. And yeah, RiseOfIron and Comet + have their own special highlight states. Don't ask me, I can't imagine they're + still used.

    +
    +
    +

    Index

    @@ -91,7 +102,7 @@

    Comet

    Comet: = 3
    @@ -101,7 +112,7 @@

    Hyper

    Hyper: = 2
    @@ -111,7 +122,7 @@

    None

    None: = 0
    @@ -121,7 +132,7 @@

    Normal

    Normal: = 1
    @@ -131,7 +142,7 @@

    RiseOfIron

    RiseOfIron: = 4
    diff --git a/docs/enums/applicationstatus.html b/docs/enums/applicationstatus.html index fad1af2..1e0207a 100644 --- a/docs/enums/applicationstatus.html +++ b/docs/enums/applicationstatus.html @@ -91,7 +91,7 @@

    Blocked

    Blocked: = 4
    @@ -108,7 +108,7 @@

    Disabled

    Disabled: = 3
    @@ -124,7 +124,7 @@

    None

    None: = 0
    @@ -139,7 +139,7 @@

    Private

    Private: = 1
    @@ -155,7 +155,7 @@

    Public

    Public: = 2
    diff --git a/docs/enums/awaresponsereason.html b/docs/enums/awaresponsereason.html index 00e01bc..ce09f68 100644 --- a/docs/enums/awaresponsereason.html +++ b/docs/enums/awaresponsereason.html @@ -90,7 +90,7 @@

    Answered

    Answered: = 1
    @@ -105,7 +105,7 @@

    None

    None: = 0
    @@ -115,7 +115,7 @@

    Replaced

    Replaced: = 3
    @@ -130,7 +130,7 @@

    TimedOut

    TimedOut: = 2
    diff --git a/docs/enums/awatype.html b/docs/enums/awatype.html index 74282c2..fe68077 100644 --- a/docs/enums/awatype.html +++ b/docs/enums/awatype.html @@ -88,7 +88,7 @@

    InsertPlugs

    InsertPlugs: = 1
    @@ -103,7 +103,7 @@

    None

    None: = 0
    diff --git a/docs/enums/awauserselection.html b/docs/enums/awauserselection.html index 50a7a4f..5c30160 100644 --- a/docs/enums/awauserselection.html +++ b/docs/enums/awauserselection.html @@ -89,7 +89,7 @@

    Approved

    Approved: = 2
    @@ -99,7 +99,7 @@

    None

    None: = 0
    @@ -109,7 +109,7 @@

    Rejected

    Rejected: = 1
    diff --git a/docs/enums/bucketcategory.html b/docs/enums/bucketcategory.html index ee4ef77..530adbf 100644 --- a/docs/enums/bucketcategory.html +++ b/docs/enums/bucketcategory.html @@ -91,7 +91,7 @@

    Currency

    Currency: = 2
    @@ -101,7 +101,7 @@

    Equippable

    Equippable: = 3
    @@ -111,7 +111,7 @@

    Ignored

    Ignored: = 4
    @@ -121,7 +121,7 @@

    Invisible

    Invisible: = 0
    @@ -131,7 +131,7 @@

    Item

    Item: = 1
    diff --git a/docs/enums/bucketscope.html b/docs/enums/bucketscope.html index 1e427b0..4b349bf 100644 --- a/docs/enums/bucketscope.html +++ b/docs/enums/bucketscope.html @@ -88,7 +88,7 @@

    Account

    Account: = 1
    @@ -98,7 +98,7 @@

    Character

    Character: = 0
    diff --git a/docs/enums/bungiemembershiptype.html b/docs/enums/bungiemembershiptype.html index 7e07a28..083dc44 100644 --- a/docs/enums/bungiemembershiptype.html +++ b/docs/enums/bungiemembershiptype.html @@ -66,6 +66,15 @@

    Enumeration BungieMembershipType

    +
    +
    +
    +

    The types of membership the Accounts system supports. This is the external + facing enum used in place of the internal-only Bungie.SharedDefinitions. + MembershipType.

    +
    +
    +

    Index

    @@ -93,7 +102,7 @@

    All

    All: = -1
    @@ -109,7 +118,7 @@

    BungieNext

    BungieNext: = 254
    @@ -119,7 +128,7 @@

    None

    None: = 0
    @@ -129,7 +138,7 @@

    TigerBlizzard

    TigerBlizzard: = 4
    @@ -139,7 +148,7 @@

    TigerDemon

    TigerDemon: = 10
    @@ -149,7 +158,7 @@

    TigerPsn

    TigerPsn: = 2
    @@ -159,7 +168,7 @@

    TigerXbox

    TigerXbox: = 1
    diff --git a/docs/enums/capabilities.html b/docs/enums/capabilities.html index e19542d..c8674b9 100644 --- a/docs/enums/capabilities.html +++ b/docs/enums/capabilities.html @@ -66,6 +66,14 @@

    Enumeration Capabilities

    +
    +
    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +
    +

    Index

    @@ -94,7 +102,7 @@

    Alliances

    Alliances: = 64
    @@ -104,7 +112,7 @@

    Callsign

    Callsign: = 2
    @@ -114,7 +122,7 @@

    ClanBanner

    ClanBanner: = 8
    @@ -124,7 +132,7 @@

    D2InvestmentData

    D2InvestmentData: = 16
    @@ -134,7 +142,7 @@

    Leaderboards

    Leaderboards: = 1
    @@ -144,7 +152,7 @@

    None

    None: = 0
    @@ -154,7 +162,7 @@

    OptionalConversations

    OptionalConversations: = 4
    @@ -164,7 +172,7 @@

    Tags

    Tags: = 32
    diff --git a/docs/enums/chatsecuritysetting.html b/docs/enums/chatsecuritysetting.html index 6c0fe45..b1c8f69 100644 --- a/docs/enums/chatsecuritysetting.html +++ b/docs/enums/chatsecuritysetting.html @@ -88,7 +88,7 @@

    Admins

    Admins: = 1
    @@ -98,7 +98,7 @@

    Group

    Group: = 0
    diff --git a/docs/enums/communitycontentsortmode.html b/docs/enums/communitycontentsortmode.html index d332786..615475f 100644 --- a/docs/enums/communitycontentsortmode.html +++ b/docs/enums/communitycontentsortmode.html @@ -89,7 +89,7 @@

    HighestRated

    HighestRated: = 2
    @@ -99,7 +99,7 @@

    Latest

    Latest: = 1
    @@ -109,7 +109,7 @@

    Trending

    Trending: = 0
    diff --git a/docs/enums/communitystatussort.html b/docs/enums/communitystatussort.html index 94fefe2..3f3c2d9 100644 --- a/docs/enums/communitystatussort.html +++ b/docs/enums/communitystatussort.html @@ -90,7 +90,7 @@

    Followers

    Followers: = 3
    @@ -100,7 +100,7 @@

    OverallViewers

    OverallViewers: = 2
    @@ -110,7 +110,7 @@

    Trending

    Trending: = 1
    @@ -120,7 +120,7 @@

    Viewers

    Viewers: = 0
    diff --git a/docs/enums/componentprivacysetting.html b/docs/enums/componentprivacysetting.html index 32661fc..cd5632f 100644 --- a/docs/enums/componentprivacysetting.html +++ b/docs/enums/componentprivacysetting.html @@ -66,6 +66,14 @@

    Enumeration ComponentPrivacySetting

    +
    +
    +
    +

    A set of flags for reason(s) why the component populated in the way that it did. + Inspect the individual flags for the reasons.

    +
    +
    +

    Index

    @@ -89,7 +97,7 @@

    None

    None: = 0
    @@ -99,7 +107,7 @@

    Private

    Private: = 2
    @@ -109,7 +117,7 @@

    Public

    Public: = 1
    diff --git a/docs/enums/contentpropertydatatypeenum.html b/docs/enums/contentpropertydatatypeenum.html index 5990251..6952d15 100644 --- a/docs/enums/contentpropertydatatypeenum.html +++ b/docs/enums/contentpropertydatatypeenum.html @@ -101,7 +101,7 @@

    Color

    Color: = 14
    @@ -111,7 +111,7 @@

    Content

    Content: = 6
    @@ -121,7 +121,7 @@

    Date

    Date: = 11
    @@ -131,7 +131,7 @@

    DestinyContent

    DestinyContent: = 13
    @@ -141,7 +141,7 @@

    Dropdown

    Dropdown: = 3
    @@ -151,7 +151,7 @@

    File

    File: = 9
    @@ -161,7 +161,7 @@

    FolderSet

    FolderSet: = 10
    @@ -171,7 +171,7 @@

    Html

    Html: = 2
    @@ -181,7 +181,7 @@

    Json

    Json: = 5
    @@ -191,7 +191,7 @@

    List

    List: = 4
    @@ -201,7 +201,7 @@

    MultilinePlaintext

    MultilinePlaintext: = 12
    @@ -211,7 +211,7 @@

    None

    None: = 0
    @@ -221,7 +221,7 @@

    Plaintext

    Plaintext: = 1
    @@ -231,7 +231,7 @@

    Representation

    Representation: = 7
    @@ -241,7 +241,7 @@

    Set

    Set: = 8
    diff --git a/docs/enums/damagetype.html b/docs/enums/damagetype.html index 9951b64..d72f9b0 100644 --- a/docs/enums/damagetype.html +++ b/docs/enums/damagetype.html @@ -92,7 +92,7 @@

    Arc

    Arc: = 2
    @@ -102,7 +102,7 @@

    Kinetic

    Kinetic: = 1
    @@ -112,7 +112,7 @@

    None

    None: = 0
    @@ -122,7 +122,7 @@

    Raid

    Raid: = 5
    @@ -132,7 +132,7 @@

    Thermal

    Thermal: = 3
    @@ -142,7 +142,7 @@

    Void

    Void: = 4
    diff --git a/docs/enums/destinyactivitydifficultytier.html b/docs/enums/destinyactivitydifficultytier.html index 1490845..925f962 100644 --- a/docs/enums/destinyactivitydifficultytier.html +++ b/docs/enums/destinyactivitydifficultytier.html @@ -66,6 +66,14 @@

    Enumeration DestinyActivityDifficultyTier

    +
    +
    +
    +

    An enumeration representing the potential difficulty levels of an activity. + Their names are... more qualitative than quantitative.

    +
    +
    +

    Index

    @@ -94,7 +102,7 @@

    AlmostImpossible

    AlmostImpossible: = 6
    @@ -104,7 +112,7 @@

    Brave

    Brave: = 5
    @@ -114,7 +122,7 @@

    Challenging

    Challenging: = 3
    @@ -124,7 +132,7 @@

    Easy

    Easy: = 1
    @@ -134,7 +142,7 @@

    Hard

    Hard: = 4
    @@ -144,7 +152,7 @@

    Impossible

    Impossible: = 7
    @@ -154,7 +162,7 @@

    Normal

    Normal: = 2
    @@ -164,7 +172,7 @@

    Trivial

    Trivial: = 0
    diff --git a/docs/enums/destinyactivitymodecategory.html b/docs/enums/destinyactivitymodecategory.html index 99c08ab..a75683a 100644 --- a/docs/enums/destinyactivitymodecategory.html +++ b/docs/enums/destinyactivitymodecategory.html @@ -66,6 +66,13 @@

    Enumeration DestinyActivityModeCategory

    +
    +
    +
    +

    Activity Modes are grouped into a few possible broad categories.

    +
    +
    +

    Index

    @@ -90,7 +97,7 @@

    None

    None: = 0
    @@ -105,7 +112,7 @@

    PvE

    PvE: = 1
    @@ -120,7 +127,7 @@

    PvECompetitive

    PvECompetitive: = 3
    @@ -136,7 +143,7 @@

    PvP

    PvP: = 2
    diff --git a/docs/enums/destinyactivitymodetype.html b/docs/enums/destinyactivitymodetype.html index ad59317..3107eef 100644 --- a/docs/enums/destinyactivitymodetype.html +++ b/docs/enums/destinyactivitymodetype.html @@ -66,6 +66,15 @@

    Enumeration DestinyActivityModeType

    +
    +
    +
    +

    For historical reasons, this list will have both D1 and D2-relevant Activity + Modes in it. Please don't take this to mean that some D1-only feature is coming + back!

    +
    +
    +

    Index

    @@ -82,11 +91,16 @@

    Enumeration members

  • BlackArmoryRun
  • Breakthrough
  • Clash
  • +
  • ClashCompetitive
  • +
  • ClashQuickplay
  • Control
  • +
  • ControlCompetitive
  • +
  • ControlQuickplay
  • Countdown
  • CrimsonDoubles
  • Doubles
  • Gambit
  • +
  • GambitPrime
  • HeroicAdventure
  • HeroicNightfall
  • IronBanner
  • @@ -106,7 +120,10 @@

    Enumeration members

  • PrivateMatchesRumble
  • PrivateMatchesSupremacy
  • PrivateMatchesSurvival
  • +
  • PvPCompetitive
  • +
  • PvPQuickplay
  • Raid
  • +
  • Reckoning
  • Reserved11
  • Reserved13
  • Reserved20
  • @@ -147,7 +164,7 @@

    AllDoubles

    AllDoubles: = 49
    @@ -157,7 +174,7 @@

    AllMayhem

    AllMayhem: = 25
    @@ -167,7 +184,7 @@

    AllPvE

    AllPvE: = 7
    @@ -177,7 +194,7 @@

    AllPvECompetitive

    AllPvECompetitive: = 64
    @@ -187,7 +204,7 @@

    AllPvP

    AllPvP: = 5
    @@ -197,7 +214,7 @@

    AllStrikes

    AllStrikes: = 18
    @@ -207,7 +224,7 @@

    BlackArmoryRun

    BlackArmoryRun: = 66
    @@ -217,7 +234,7 @@

    Breakthrough

    Breakthrough: = 65
    @@ -227,7 +244,7 @@

    Clash

    Clash: = 12
    @@ -237,13 +254,53 @@

    Clash

    +
    + +

    ClashCompetitive

    +
    ClashCompetitive: = 72
    + +
    +
    + +

    ClashQuickplay

    +
    ClashQuickplay: = 71
    + +

    Control

    Control: = 10
    +
    +
    + +

    ControlCompetitive

    +
    ControlCompetitive: = 74
    + +
    +
    + +

    ControlQuickplay

    +
    ControlQuickplay: = 73
    +
    @@ -253,7 +310,7 @@

    Countdown

    Countdown: = 38
    @@ -263,7 +320,7 @@

    CrimsonDoubles

    CrimsonDoubles: = 15
    @@ -273,7 +330,7 @@

    Doubles

    Doubles: = 50
    @@ -283,7 +340,17 @@

    Gambit

    Gambit: = 63
    + +
    + +

    GambitPrime

    +
    GambitPrime: = 75
    +
    @@ -293,7 +360,7 @@

    HeroicAdventure

    HeroicAdventure: = 58
    @@ -303,7 +370,7 @@

    HeroicNightfall

    HeroicNightfall: = 17
    @@ -313,7 +380,7 @@

    IronBanner

    IronBanner: = 19
    @@ -323,7 +390,7 @@

    IronBannerClash

    IronBannerClash: = 44
    @@ -333,7 +400,7 @@

    IronBannerControl

    IronBannerControl: = 43
    @@ -343,7 +410,7 @@

    IronBannerSalvage

    IronBannerSalvage: = 68
    @@ -353,7 +420,7 @@

    IronBannerSupremacy

    IronBannerSupremacy: = 45
    @@ -363,7 +430,7 @@

    Lockdown

    Lockdown: = 60
    @@ -373,7 +440,7 @@

    Nightfall

    Nightfall: = 16
    @@ -383,7 +450,7 @@

    None

    None: = 0
    @@ -393,7 +460,7 @@

    Patrol

    Patrol: = 6
    @@ -403,7 +470,7 @@

    PrivateMatchesAll

    PrivateMatchesAll: = 32
    @@ -413,7 +480,7 @@

    PrivateMatchesClash

    PrivateMatchesClash: = 51
    @@ -423,7 +490,7 @@

    PrivateMatchesControl

    PrivateMatchesControl: = 52
    @@ -433,7 +500,7 @@

    PrivateMatchesCountdown

    PrivateMatchesCountdown: = 54
    @@ -443,7 +510,7 @@

    PrivateMatchesMayhem

    PrivateMatchesMayhem: = 56
    @@ -453,7 +520,7 @@

    PrivateMatchesRumble

    PrivateMatchesRumble: = 57
    @@ -463,7 +530,7 @@

    PrivateMatchesSupremacy

    PrivateMatchesSupremacy: = 53
    @@ -473,7 +540,27 @@

    PrivateMatchesSurvival

    PrivateMatchesSurvival: = 55
    + +
    + +

    PvPCompetitive

    +
    PvPCompetitive: = 69
    + +
    +
    + +

    PvPQuickplay

    +
    PvPQuickplay: = 70
    +
    @@ -483,7 +570,17 @@

    Raid

    Raid: = 4
    + +
    + +

    Reckoning

    +
    Reckoning: = 76
    +
    @@ -493,7 +590,7 @@

    Reserved11

    Reserved11: = 11
    @@ -503,7 +600,7 @@

    Reserved13

    Reserved13: = 13
    @@ -513,7 +610,7 @@

    Reserved20

    Reserved20: = 20
    @@ -523,7 +620,7 @@

    Reserved21

    Reserved21: = 21
    @@ -533,7 +630,7 @@

    Reserved22

    Reserved22: = 22
    @@ -543,7 +640,7 @@

    Reserved24

    Reserved24: = 24
    @@ -553,7 +650,7 @@

    Reserved26

    Reserved26: = 26
    @@ -563,7 +660,7 @@

    Reserved27

    Reserved27: = 27
    @@ -573,7 +670,7 @@

    Reserved28

    Reserved28: = 28
    @@ -583,7 +680,7 @@

    Reserved29

    Reserved29: = 29
    @@ -593,7 +690,7 @@

    Reserved30

    Reserved30: = 30
    @@ -603,7 +700,7 @@

    Reserved9

    Reserved9: = 9
    @@ -613,7 +710,7 @@

    Rumble

    Rumble: = 48
    @@ -623,7 +720,7 @@

    Salvage

    Salvage: = 67
    @@ -633,7 +730,7 @@

    Scorched

    Scorched: = 61
    @@ -643,7 +740,7 @@

    ScorchedTeam

    ScorchedTeam: = 62
    @@ -653,7 +750,7 @@

    ScoredHeroicNightfall

    ScoredHeroicNightfall: = 47
    @@ -663,7 +760,7 @@

    ScoredNightfall

    ScoredNightfall: = 46
    @@ -673,7 +770,7 @@

    Showdown

    Showdown: = 59
    @@ -683,7 +780,7 @@

    Social

    Social: = 40
    @@ -693,7 +790,7 @@

    Story

    Story: = 2
    @@ -703,7 +800,7 @@

    Strike

    Strike: = 3
    @@ -713,7 +810,7 @@

    Supremacy

    Supremacy: = 31
    @@ -723,7 +820,7 @@

    Survival

    Survival: = 37
    @@ -733,7 +830,7 @@

    TrialsCountdown

    TrialsCountdown: = 41
    @@ -743,7 +840,7 @@

    TrialsOfTheNine

    TrialsOfTheNine: = 39
    @@ -753,7 +850,7 @@

    TrialsSurvival

    TrialsSurvival: = 42
    @@ -801,9 +898,21 @@

    TrialsSurvival

  • Clash
  • +
  • + ClashCompetitive +
  • +
  • + ClashQuickplay +
  • Control
  • +
  • + ControlCompetitive +
  • +
  • + ControlQuickplay +
  • Countdown
  • @@ -816,6 +925,9 @@

    TrialsSurvival

  • Gambit
  • +
  • + GambitPrime +
  • HeroicAdventure
  • @@ -873,9 +985,18 @@

    TrialsSurvival

  • PrivateMatchesSurvival
  • +
  • + PvPCompetitive +
  • +
  • + PvPQuickplay +
  • Raid
  • +
  • + Reckoning +
  • Reserved11
  • diff --git a/docs/enums/destinyactivitynavpointtype.html b/docs/enums/destinyactivitynavpointtype.html index 7f3726b..6e51189 100644 --- a/docs/enums/destinyactivitynavpointtype.html +++ b/docs/enums/destinyactivitynavpointtype.html @@ -103,7 +103,7 @@

    AmmoCache

    AmmoCache: = 5
    @@ -113,7 +113,7 @@

    ArenaObjective

    ArenaObjective: = 14
    @@ -123,7 +123,7 @@

    AutomationHint

    AutomationHint: = 15
    @@ -133,7 +133,7 @@

    CapturePoint

    CapturePoint: = 7
    @@ -143,7 +143,7 @@

    DefensiveEncounter

    DefensiveEncounter: = 8
    @@ -153,7 +153,7 @@

    GhostInteraction

    GhostInteraction: = 9
    @@ -163,7 +163,7 @@

    Inactive

    Inactive: = 0
    @@ -173,7 +173,7 @@

    Incoming

    Incoming: = 13
    @@ -183,7 +183,7 @@

    KillAi

    KillAi: = 10
    @@ -193,7 +193,7 @@

    PatrolMission

    PatrolMission: = 12
    @@ -203,7 +203,7 @@

    PointTypeFlag

    PointTypeFlag: = 6
    @@ -213,7 +213,7 @@

    PrimaryObjective

    PrimaryObjective: = 1
    @@ -223,7 +223,7 @@

    PublicEventObjective

    PublicEventObjective: = 4
    @@ -233,7 +233,7 @@

    QuestItem

    QuestItem: = 11
    @@ -243,7 +243,7 @@

    SecondaryObjective

    SecondaryObjective: = 2
    @@ -253,7 +253,7 @@

    TrackedQuest

    TrackedQuest: = 16
    @@ -263,7 +263,7 @@

    TravelObjective

    TravelObjective: = 3
    diff --git a/docs/enums/destinyammunitiontype.html b/docs/enums/destinyammunitiontype.html index a8ef4d2..4f42877 100644 --- a/docs/enums/destinyammunitiontype.html +++ b/docs/enums/destinyammunitiontype.html @@ -91,7 +91,7 @@

    Heavy

    Heavy: = 3
    @@ -101,7 +101,7 @@

    None

    None: = 0
    @@ -111,7 +111,7 @@

    Primary

    Primary: = 1
    @@ -121,7 +121,7 @@

    Special

    Special: = 2
    @@ -131,7 +131,7 @@

    Unknown

    Unknown: = 4
    diff --git a/docs/enums/destinyclass.html b/docs/enums/destinyclass.html index f5a66fc..3e36ff5 100644 --- a/docs/enums/destinyclass.html +++ b/docs/enums/destinyclass.html @@ -90,7 +90,7 @@

    Hunter

    Hunter: = 1
    @@ -100,7 +100,7 @@

    Titan

    Titan: = 0
    @@ -110,7 +110,7 @@

    Unknown

    Unknown: = 3
    @@ -120,7 +120,7 @@

    Warlock

    Warlock: = 2
    diff --git a/docs/enums/destinycollectiblestate.html b/docs/enums/destinycollectiblestate.html index f4397a2..a3d3dae 100644 --- a/docs/enums/destinycollectiblestate.html +++ b/docs/enums/destinycollectiblestate.html @@ -66,6 +66,26 @@

    Enumeration DestinyCollectibleState

    +
    +
    +
    +

    A Flags Enumeration/bitmask where each bit represents a different state that the + Collectible can be in. A collectible can be in any number of these states, and + you can choose to use or ignore any or all of them when making your own UI that + shows Collectible info. Our displays are going to honor them, but we're also the + kind of people who only pretend to inhale before quickly passing it to the left. + So, you know, do what you got to do.

    +
    +

    (All joking aside, please note the caveat I mention around the Invisible flag: + there are cases where it is in the best interest of your users to honor these + flags even if you're a "show all the data" person. Collector-oriented compulsion + is a very unfortunate and real thing, and I would hate to instill that + compulsion in others through showing them items that they cannot earn. Please + consider this when you are making your own apps/sites.)

    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +

    Index

    @@ -94,7 +114,7 @@

    CannotAffordMaterialRequirements

    CannotAffordMaterialRequirements: = 8
    @@ -111,7 +131,7 @@

    InventorySpaceUnavailable

    InventorySpaceUnavailable: = 16
    @@ -127,7 +147,7 @@

    Invisible

    Invisible: = 4
    @@ -150,7 +170,7 @@

    None

    None: = 0
    @@ -160,7 +180,7 @@

    NotAcquired

    NotAcquired: = 1
    @@ -175,7 +195,7 @@

    Obscured

    Obscured: = 2
    @@ -193,7 +213,7 @@

    PurchaseDisabled

    PurchaseDisabled: = 64
    @@ -209,7 +229,7 @@

    UniquenessViolation

    UniquenessViolation: = 32
    diff --git a/docs/enums/destinycomponenttype.html b/docs/enums/destinycomponenttype.html index 405c9d4..7d7c4c7 100644 --- a/docs/enums/destinycomponenttype.html +++ b/docs/enums/destinycomponenttype.html @@ -66,6 +66,19 @@

    Enumeration DestinyComponentType

    +
    +
    +
    +

    Represents the possible components that can be returned from Destiny "Get" calls + such as GetProfile, GetCharacter, GetVendor etc...

    +
    +

    When making one of these requests, you will pass one or more of these components + as a comma separated list in the "?components=" querystring parameter. For + instance, if you want baseline Profile data, Character Data, and character + progressions, you would pass "?components=Profiles,Characters, + CharacterProgressions" You may use either the numerical or string values.

    +
    +

    Index

    @@ -115,7 +128,7 @@

    CharacterActivities

    CharacterActivities: = 204
    @@ -134,7 +147,7 @@

    CharacterEquipment

    CharacterEquipment: = 205
    @@ -150,7 +163,7 @@

    CharacterInventories

    CharacterInventories: = 201
    @@ -168,7 +181,7 @@

    CharacterProgressions

    CharacterProgressions: = 202
    @@ -185,7 +198,7 @@

    CharacterRenderData

    CharacterRenderData: = 203
    @@ -203,7 +216,7 @@

    Characters

    Characters: = 200
    @@ -218,7 +231,7 @@

    Collectibles

    Collectibles: = 800
    @@ -236,7 +249,7 @@

    CurrencyLookups

    CurrencyLookups: = 600
    @@ -255,7 +268,7 @@

    ItemCommonData

    ItemCommonData: = 307
    @@ -275,7 +288,7 @@

    ItemInstances

    ItemInstances: = 300
    @@ -292,7 +305,7 @@

    ItemObjectives

    ItemObjectives: = 301
    @@ -308,7 +321,7 @@

    ItemPerks

    ItemPerks: = 302
    @@ -324,7 +337,7 @@

    ItemPlugStates

    ItemPlugStates: = 308
    @@ -342,7 +355,7 @@

    ItemRenderData

    ItemRenderData: = 303
    @@ -358,7 +371,7 @@

    ItemSockets

    ItemSockets: = 305
    @@ -374,7 +387,7 @@

    ItemStats

    ItemStats: = 304
    @@ -390,7 +403,7 @@

    ItemTalentGrids

    ItemTalentGrids: = 306
    @@ -407,7 +420,7 @@

    Kiosks

    Kiosks: = 500
    @@ -425,7 +438,7 @@

    None

    None: = 0
    @@ -435,7 +448,7 @@

    PresentationNodes

    PresentationNodes: = 700
    @@ -454,7 +467,7 @@

    ProfileCurrencies

    ProfileCurrencies: = 103
    @@ -471,7 +484,7 @@

    ProfileInventories

    ProfileInventories: = 102
    @@ -487,7 +500,7 @@

    ProfileProgression

    ProfileProgression: = 104
    @@ -503,7 +516,7 @@

    Profiles

    Profiles: = 100
    @@ -521,7 +534,7 @@

    Records

    Records: = 900
    @@ -538,7 +551,7 @@

    VendorCategories

    VendorCategories: = 401
    @@ -554,7 +567,7 @@

    VendorReceipts

    VendorReceipts: = 101
    @@ -570,7 +583,7 @@

    VendorSales

    VendorSales: = 402
    @@ -586,7 +599,7 @@

    Vendors

    Vendors: = 400
    diff --git a/docs/enums/destinygameversions.html b/docs/enums/destinygameversions.html index 7aa535f..938635e 100644 --- a/docs/enums/destinygameversions.html +++ b/docs/enums/destinygameversions.html @@ -66,6 +66,16 @@

    Enumeration DestinyGameVersions

    +
    +
    +
    +

    A flags enumeration/bitmask indicating the versions of the game that a given + user has purchased.

    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +

    Index

    @@ -92,7 +102,7 @@

    DLC1

    DLC1: = 2
    @@ -102,7 +112,7 @@

    DLC2

    DLC2: = 4
    @@ -112,7 +122,7 @@

    Destiny2

    Destiny2: = 1
    @@ -122,7 +132,7 @@

    Forsaken

    Forsaken: = 8
    @@ -132,7 +142,7 @@

    None

    None: = 0
    @@ -142,7 +152,7 @@

    YearTwoAnnualPass

    YearTwoAnnualPass: = 16
    diff --git a/docs/enums/destinygatingscope.html b/docs/enums/destinygatingscope.html index 54b83fa..e76ca42 100644 --- a/docs/enums/destinygatingscope.html +++ b/docs/enums/destinygatingscope.html @@ -66,6 +66,37 @@

    Enumeration DestinyGatingScope

    +
    +
    +
    +

    This enumeration represents the most restrictive type of gating that is being + performed by an entity. This is useful as a shortcut to avoid a lot of lookups + when determining whether the gating on an Entity applies to everyone equally, or + to their specific Profile or Character states.

    +
    +

    None = There is no gating on this item.

    +

    Global = The gating on this item is based entirely on global game state. It will + be gated the same for everyone.

    +

    Clan = The gating on this item is at the Clan level. For instance, if you're + gated by Clan level this will be the case.

    +

    Profile = The gating includes Profile-specific checks, but not on the Profile's + characters. An example of this might be when you acquire an Emblem: the Emblem + will be available in your Kiosk for all characters in your Profile from that + point onward.

    +

    Character = The gating includes Character-specific checks, including character + level restrictions. An example of this might be an item that you can't purchase + from a Vendor until you reach a specific Character Level.

    +

    Item = The gating includes item-specific checks. For BNet, this generally + implies that we'll show this data only on a character level or deeper.

    +

    AssumedWorstCase = The unlocks and checks being used for this calculation are of + an unknown type and are used for unknown purposes. For instance, if some great + person decided that an unlock value should be globally scoped, but then the game + changes it using character-specific data in a way that BNet doesn't know about. + Because of the open-ended potential for this to occur, many unlock checks for " + globally" scoped unlock data may be assumed as the worst case unless it has been + specifically whitelisted as otherwise. That sucks, but them's the breaks.

    +
    +

    Index

    @@ -93,7 +124,7 @@

    AssumedWorstCase

    AssumedWorstCase: = 6
    @@ -103,7 +134,7 @@

    Character

    Character: = 4
    @@ -113,7 +144,7 @@

    Clan

    Clan: = 2
    @@ -123,7 +154,7 @@

    Global

    Global: = 1
    @@ -133,7 +164,7 @@

    Item

    Item: = 5
    @@ -143,7 +174,7 @@

    None

    None: = 0
    @@ -153,7 +184,7 @@

    Profile

    Profile: = 3
    diff --git a/docs/enums/destinygender.html b/docs/enums/destinygender.html index 53fa9a7..3f5bbeb 100644 --- a/docs/enums/destinygender.html +++ b/docs/enums/destinygender.html @@ -89,7 +89,7 @@

    Female

    Female: = 1
    @@ -99,7 +99,7 @@

    Male

    Male: = 0
    @@ -109,7 +109,7 @@

    Unknown

    Unknown: = 2
    diff --git a/docs/enums/destinygraphnodestate.html b/docs/enums/destinygraphnodestate.html index d1e375c..8d572e3 100644 --- a/docs/enums/destinygraphnodestate.html +++ b/docs/enums/destinygraphnodestate.html @@ -66,6 +66,13 @@

    Enumeration DestinyGraphNodeState

    +
    +
    +
    +

    Represents a potential state of an Activity Graph node.

    +
    +
    +

    Index

    @@ -91,7 +98,7 @@

    Completed

    Completed: = 4
    @@ -101,7 +108,7 @@

    Hidden

    Hidden: = 0
    @@ -111,7 +118,7 @@

    Incomplete

    Incomplete: = 3
    @@ -121,7 +128,7 @@

    Teaser

    Teaser: = 2
    @@ -131,7 +138,7 @@

    Visible

    Visible: = 1
    diff --git a/docs/enums/destinyitemsorttype.html b/docs/enums/destinyitemsorttype.html index 43cf51c..0e2438e 100644 --- a/docs/enums/destinyitemsorttype.html +++ b/docs/enums/destinyitemsorttype.html @@ -66,6 +66,13 @@

    Enumeration DestinyItemSortType

    +
    +
    +
    +

    Determines how items are sorted in an inventory bucket.

    +
    +
    +

    Index

    @@ -89,7 +96,7 @@

    ItemId

    ItemId: = 0
    @@ -99,7 +106,7 @@

    StackSize

    StackSize: = 2
    @@ -109,7 +116,7 @@

    Timestamp

    Timestamp: = 1
    diff --git a/docs/enums/destinyitemsubtype.html b/docs/enums/destinyitemsubtype.html index de92420..12d8be7 100644 --- a/docs/enums/destinyitemsubtype.html +++ b/docs/enums/destinyitemsubtype.html @@ -66,6 +66,24 @@

    Enumeration DestinyItemSubType

    +
    +
    +
    +

    This Enumeration further classifies items by more specific categorizations than + DestinyItemType. The "Sub-Type" is where we classify and categorize items one + step further in specificity: "Auto Rifle" instead of just "Weapon" for example, + or "Vanguard Bounty" instead of merely "Bounty".

    +
    +

    These sub-types are provided for historical compatibility with Destiny 1, but an + ideal alternative is to use DestinyItemCategoryDefinitions and the + DestinyItemDefinition.itemCategories property instead. Item Categories allow for + arbitrary hierarchies of specificity, and for items to belong to multiple + categories across multiple hierarchies simultaneously. For this enum, we pick a + single type as a "best guess" fit.

    +

    NOTE: This is not all of the item types available, and some of these are + holdovers from Destiny 1 that may or may not still exist.

    +
    +

    Index

    @@ -115,7 +133,7 @@

    AutoRifle

    AutoRifle: = 6
    @@ -125,7 +143,7 @@

    Bow

    Bow: = 31
    @@ -135,7 +153,7 @@

    ChestArmor

    ChestArmor: = 28
    @@ -145,7 +163,7 @@

    ClassArmor

    ClassArmor: = 30
    @@ -155,7 +173,7 @@

    Crm

    Crm: = 16
    @@ -170,7 +188,7 @@

    Crucible

    Crucible: = 1
    @@ -185,7 +203,7 @@

    Exotic

    Exotic: = 5
    @@ -200,7 +218,7 @@

    FusionRifle

    FusionRifle: = 11
    @@ -210,7 +228,7 @@

    FusionRifleLine

    FusionRifleLine: = 22
    @@ -220,7 +238,7 @@

    GauntletsArmor

    GauntletsArmor: = 27
    @@ -230,7 +248,7 @@

    GrenadeLauncher

    GrenadeLauncher: = 23
    @@ -240,7 +258,7 @@

    HandCannon

    HandCannon: = 9
    @@ -250,7 +268,7 @@

    HelmetArmor

    HelmetArmor: = 26
    @@ -260,7 +278,7 @@

    LegArmor

    LegArmor: = 29
    @@ -270,7 +288,7 @@

    Machinegun

    Machinegun: = 8
    @@ -280,7 +298,7 @@

    Mask

    Mask: = 19
    @@ -290,7 +308,7 @@

    None

    None: = 0
    @@ -300,7 +318,7 @@

    Ornament

    Ornament: = 21
    @@ -310,7 +328,7 @@

    PulseRifle

    PulseRifle: = 13
    @@ -320,7 +338,7 @@

    RocketLauncher

    RocketLauncher: = 10
    @@ -330,7 +348,7 @@

    ScoutRifle

    ScoutRifle: = 14
    @@ -340,7 +358,7 @@

    Shader

    Shader: = 20
    @@ -350,7 +368,7 @@

    Shotgun

    Shotgun: = 7
    @@ -360,7 +378,7 @@

    Sidearm

    Sidearm: = 17
    @@ -370,7 +388,7 @@

    SniperRifle

    SniperRifle: = 12
    @@ -380,7 +398,7 @@

    SubmachineGun

    SubmachineGun: = 24
    @@ -390,7 +408,7 @@

    Sword

    Sword: = 18
    @@ -400,7 +418,7 @@

    TraceRifle

    TraceRifle: = 25
    @@ -410,7 +428,7 @@

    Vanguard

    Vanguard: = 2
    diff --git a/docs/enums/destinyitemtype.html b/docs/enums/destinyitemtype.html index 1550a52..4a22cf2 100644 --- a/docs/enums/destinyitemtype.html +++ b/docs/enums/destinyitemtype.html @@ -66,6 +66,27 @@

    Enumeration DestinyItemType

    +
    +
    +
    +

    An enumeration that indicates the high-level "type" of the item, attempting to + iron out the context specific differences for specific instances of an entity. + For instance, though a weapon may be of various weapon "Types", in + DestinyItemType they are all classified as "Weapon". This allows for better + filtering on a higher level of abstraction for the concept of types.

    +
    +

    This enum is provided for historical compatibility with Destiny 1, but an ideal + alternative is to use DestinyItemCategoryDefinitions and the + DestinyItemDefinition.itemCategories property instead. Item Categories allow for + arbitrary hierarchies of specificity, and for items to belong to multiple + categories across multiple hierarchies simultaneously. For this enum, we pick a + single type as a "best guess" fit.

    +

    NOTE: This is not all of the item types available, and some of these are + holdovers from Destiny 1 that may or may not still exist.

    +

    I keep updating these because they're so damn convenient. I guess I shouldn't + fight it.

    +
    +

    Index

    @@ -110,7 +131,7 @@

    Armor

    Armor: = 2
    @@ -120,7 +141,7 @@

    Aura

    Aura: = 18
    @@ -130,7 +151,7 @@

    Bounty

    Bounty: = 26
    @@ -140,7 +161,7 @@

    ClanBanner

    ClanBanner: = 17
    @@ -150,7 +171,7 @@

    Consumable

    Consumable: = 9
    @@ -160,7 +181,7 @@

    Currency

    Currency: = 1
    @@ -170,7 +191,7 @@

    Dummy

    Dummy: = 20
    @@ -180,7 +201,7 @@

    Emblem

    Emblem: = 14
    @@ -190,7 +211,7 @@

    Emote

    Emote: = 23
    @@ -200,7 +221,7 @@

    Engram

    Engram: = 8
    @@ -210,7 +231,7 @@

    ExchangeMaterial

    ExchangeMaterial: = 10
    @@ -220,7 +241,7 @@

    Ghost

    Ghost: = 24
    @@ -230,7 +251,7 @@

    Message

    Message: = 7
    @@ -240,7 +261,7 @@

    MissionReward

    MissionReward: = 11
    @@ -250,7 +271,7 @@

    Mod

    Mod: = 19
    @@ -260,7 +281,7 @@

    None

    None: = 0
    @@ -270,7 +291,7 @@

    Package

    Package: = 25
    @@ -280,7 +301,7 @@

    Quest

    Quest: = 15
    @@ -290,7 +311,7 @@

    QuestStep

    QuestStep: = 12
    @@ -300,7 +321,7 @@

    QuestStepComplete

    QuestStepComplete: = 13
    @@ -310,7 +331,7 @@

    Ship

    Ship: = 21
    @@ -320,7 +341,7 @@

    Subclass

    Subclass: = 16
    @@ -330,7 +351,7 @@

    Vehicle

    Vehicle: = 22
    @@ -340,7 +361,7 @@

    Weapon

    Weapon: = 3
    diff --git a/docs/enums/destinymilestonetype.html b/docs/enums/destinymilestonetype.html index c530f5b..85f0b5e 100644 --- a/docs/enums/destinymilestonetype.html +++ b/docs/enums/destinymilestonetype.html @@ -66,6 +66,14 @@

    Enumeration DestinyMilestoneType

    +
    +
    +
    +

    The type of milestone. Milestones can be Tutorials, one-time/triggered/non- + repeating but not necessarily tutorials, or Repeating Milestones.

    +
    +
    +

    Index

    @@ -92,7 +100,7 @@

    Daily

    Daily: = 4
    @@ -107,7 +115,7 @@

    OneTime

    OneTime: = 2
    @@ -122,7 +130,7 @@

    Special

    Special: = 5
    @@ -139,7 +147,7 @@

    Tutorial

    Tutorial: = 1
    @@ -155,7 +163,7 @@

    Unknown

    Unknown: = 0
    @@ -165,7 +173,7 @@

    Weekly

    Weekly: = 3
    diff --git a/docs/enums/destinyobjectivegrantstyle.html b/docs/enums/destinyobjectivegrantstyle.html index 011b991..b806ffa 100644 --- a/docs/enums/destinyobjectivegrantstyle.html +++ b/docs/enums/destinyobjectivegrantstyle.html @@ -66,6 +66,15 @@

    Enumeration DestinyObjectiveGrantStyle

    +
    +
    +
    +

    Some Objectives provide perks, generally as part of providing some kind of + interesting modifier for a Challenge or Quest. This indicates when the Perk is + granted.

    +
    +
    +

    Index

    @@ -89,7 +98,7 @@

    Always

    Always: = 2
    @@ -99,7 +108,7 @@

    WhenComplete

    WhenComplete: = 1
    @@ -109,7 +118,7 @@

    WhenIncomplete

    WhenIncomplete: = 0
    diff --git a/docs/enums/destinypresentationdisplaystyle.html b/docs/enums/destinypresentationdisplaystyle.html index 960b821..c2fde9b 100644 --- a/docs/enums/destinypresentationdisplaystyle.html +++ b/docs/enums/destinypresentationdisplaystyle.html @@ -66,6 +66,14 @@

    Enumeration DestinyPresentationDisplayStyle

    +
    +
    +
    +

    A hint for how the presentation node should be displayed when shown in a list. + How you use this is your UI is up to you.

    +
    +
    +

    Index

    @@ -91,7 +99,7 @@

    Badge

    Badge: = 1
    @@ -101,7 +109,7 @@

    Category

    Category: = 0
    @@ -116,7 +124,7 @@

    Collectible

    Collectible: = 3
    @@ -126,7 +134,7 @@

    Medals

    Medals: = 2
    @@ -136,7 +144,7 @@

    Record

    Record: = 4
    diff --git a/docs/enums/destinypresentationnodestate.html b/docs/enums/destinypresentationnodestate.html index 445526c..1dfcb5a 100644 --- a/docs/enums/destinypresentationnodestate.html +++ b/docs/enums/destinypresentationnodestate.html @@ -66,6 +66,18 @@

    Enumeration DestinyPresentationNodeState

    +
    +
    +
    +

    I know this doesn't look like a Flags Enumeration/bitmask right now, but I + assure you it is. This is the possible states that a Presentation Node can be in, + and it is almost certain that its potential states will increase in the future. + So don't treat it like a straight up enumeration.

    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +

    Index

    @@ -89,7 +101,7 @@

    Invisible

    Invisible: = 1
    @@ -105,7 +117,7 @@

    None

    None: = 0
    @@ -115,7 +127,7 @@

    Obscured

    Obscured: = 2
    diff --git a/docs/enums/destinypresentationnodetype.html b/docs/enums/destinypresentationnodetype.html index f75aa07..a2a9368 100644 --- a/docs/enums/destinypresentationnodetype.html +++ b/docs/enums/destinypresentationnodetype.html @@ -90,7 +90,7 @@

    Category

    Category: = 1
    @@ -100,7 +100,7 @@

    Collectibles

    Collectibles: = 2
    @@ -110,7 +110,7 @@

    Default

    Default: = 0
    @@ -120,7 +120,7 @@

    Records

    Records: = 3
    diff --git a/docs/enums/destinypresentationscreenstyle.html b/docs/enums/destinypresentationscreenstyle.html index d815ecb..93066a7 100644 --- a/docs/enums/destinypresentationscreenstyle.html +++ b/docs/enums/destinypresentationscreenstyle.html @@ -66,6 +66,14 @@

    Enumeration DestinyPresentationScreenStyle

    +
    +
    +
    +

    A hint for what screen should be shown when this presentation node is clicked + into. How you use this is your UI is up to you.

    +
    +
    +

    Index

    @@ -89,7 +97,7 @@

    Badge

    Badge: = 2
    @@ -105,7 +113,7 @@

    CategorySets

    CategorySets: = 1
    @@ -122,7 +130,7 @@

    Default

    Default: = 0
    diff --git a/docs/enums/destinyprogressionscope.html b/docs/enums/destinyprogressionscope.html index 971d5bc..3f43ca4 100644 --- a/docs/enums/destinyprogressionscope.html +++ b/docs/enums/destinyprogressionscope.html @@ -66,6 +66,16 @@

    Enumeration DestinyProgressionScope

    +
    +
    +
    +

    There are many Progressions in Destiny (think Character Level, or Reputation). + These are the various "Scopes" of Progressions, which affect many things: * + Where/if they are stored * How they are calculated * Where they can be used in + other game logic

    +
    +
    +

    Index

    @@ -95,7 +105,7 @@

    Account

    Account: = 0
    @@ -105,7 +115,7 @@

    Character

    Character: = 1
    @@ -115,7 +125,7 @@

    Clan

    Clan: = 2
    @@ -125,7 +135,7 @@

    ImplicitFromEquipment

    ImplicitFromEquipment: = 4
    @@ -135,7 +145,7 @@

    Item

    Item: = 3
    @@ -145,7 +155,7 @@

    Mapped

    Mapped: = 5
    @@ -155,7 +165,7 @@

    MappedAggregate

    MappedAggregate: = 6
    @@ -165,7 +175,7 @@

    MappedStat

    MappedStat: = 7
    @@ -175,7 +185,7 @@

    MappedUnlockValue

    MappedUnlockValue: = 8
    diff --git a/docs/enums/destinyprogressionstepdisplayeffect.html b/docs/enums/destinyprogressionstepdisplayeffect.html index 52f7146..a3d8a57 100644 --- a/docs/enums/destinyprogressionstepdisplayeffect.html +++ b/docs/enums/destinyprogressionstepdisplayeffect.html @@ -66,6 +66,14 @@

    Enumeration DestinyProgressionStepDisplayEffect

    +
    +
    +
    +

    If progression is earned, this determines whether the progression shows visual + effects on the character or its item - or neither.

    +
    +
    +

    Index

    @@ -89,7 +97,7 @@

    Character

    Character: = 1
    @@ -99,7 +107,7 @@

    Item

    Item: = 2
    @@ -109,7 +117,7 @@

    None

    None: = 0
    diff --git a/docs/enums/destinyrace.html b/docs/enums/destinyrace.html index 9574884..270fa61 100644 --- a/docs/enums/destinyrace.html +++ b/docs/enums/destinyrace.html @@ -90,7 +90,7 @@

    Awoken

    Awoken: = 1
    @@ -100,7 +100,7 @@

    Exo

    Exo: = 2
    @@ -110,7 +110,7 @@

    Human

    Human: = 0
    @@ -120,7 +120,7 @@

    Unknown

    Unknown: = 3
    diff --git a/docs/enums/destinyrecordstate.html b/docs/enums/destinyrecordstate.html index a859e20..5a192df 100644 --- a/docs/enums/destinyrecordstate.html +++ b/docs/enums/destinyrecordstate.html @@ -66,6 +66,16 @@

    Enumeration DestinyRecordState

    +
    +
    +
    +

    A Flags enumeration/bitmask where each bit represents a possible state that a + Record/Triumph can be in.

    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +

    Index

    @@ -94,7 +104,7 @@

    CanEquipTitle

    CanEquipTitle: = 64
    @@ -110,7 +120,7 @@

    EntitlementUnowned

    EntitlementUnowned: = 32
    @@ -126,7 +136,7 @@

    Invisible

    Invisible: = 16
    @@ -142,7 +152,7 @@

    None

    None: = 0
    @@ -158,7 +168,7 @@

    ObjectiveNotCompleted

    ObjectiveNotCompleted: = 4
    @@ -173,7 +183,7 @@

    Obscured

    Obscured: = 8
    @@ -189,7 +199,7 @@

    RecordRedeemed

    RecordRedeemed: = 1
    @@ -204,7 +214,7 @@

    RewardUnavailable

    RewardUnavailable: = 2
    diff --git a/docs/enums/destinyrecordtoaststyle.html b/docs/enums/destinyrecordtoaststyle.html index 2136847..c7778c9 100644 --- a/docs/enums/destinyrecordtoaststyle.html +++ b/docs/enums/destinyrecordtoaststyle.html @@ -92,7 +92,7 @@

    Badge

    Badge: = 3
    @@ -102,7 +102,7 @@

    Lore

    Lore: = 2
    @@ -112,7 +112,7 @@

    MedalComplete

    MedalComplete: = 5
    @@ -122,7 +122,7 @@

    MetaRecord

    MetaRecord: = 4
    @@ -132,7 +132,7 @@

    None

    None: = 0
    @@ -142,7 +142,7 @@

    Record

    Record: = 1
    diff --git a/docs/enums/destinyrecordvaluestyle.html b/docs/enums/destinyrecordvaluestyle.html index e8db900..414d359 100644 --- a/docs/enums/destinyrecordvaluestyle.html +++ b/docs/enums/destinyrecordvaluestyle.html @@ -91,7 +91,7 @@

    Boolean

    Boolean: = 3
    @@ -101,7 +101,7 @@

    Decimal

    Decimal: = 4
    @@ -111,7 +111,7 @@

    Integer

    Integer: = 0
    @@ -121,7 +121,7 @@

    Milliseconds

    Milliseconds: = 2
    @@ -131,7 +131,7 @@

    Percentage

    Percentage: = 1
    diff --git a/docs/enums/destinyrewardsourcecategory.html b/docs/enums/destinyrewardsourcecategory.html index 3f56f9d..d14e421 100644 --- a/docs/enums/destinyrewardsourcecategory.html +++ b/docs/enums/destinyrewardsourcecategory.html @@ -66,6 +66,15 @@

    Enumeration DestinyRewardSourceCategory

    +
    +
    +
    +

    BNet's custom categorization of reward sources. We took a look at the existing + ways that items could be spawned, and tried to make high-level categorizations + of them. This needs to be re-evaluated for Destiny 2.

    +
    +
    +

    Index

    @@ -90,7 +99,7 @@

    Activity

    Activity: = 1
    @@ -106,7 +115,7 @@

    Aggregate

    Aggregate: = 3
    @@ -125,7 +134,7 @@

    None

    None: = 0
    @@ -140,7 +149,7 @@

    Vendor

    Vendor: = 2
    diff --git a/docs/enums/destinyscope.html b/docs/enums/destinyscope.html index 5400e0a..b54634f 100644 --- a/docs/enums/destinyscope.html +++ b/docs/enums/destinyscope.html @@ -66,6 +66,15 @@

    Enumeration DestinyScope

    +
    +
    +
    +

    There's a lot of places where we need to know scope on more than just a profile + or character level. For everything else, there's this more generic sense of + scope.

    +
    +
    +

    Index

    @@ -88,7 +97,7 @@

    Character

    Character: = 1
    @@ -98,7 +107,7 @@

    Profile

    Profile: = 0
    diff --git a/docs/enums/destinysocketarraytype.html b/docs/enums/destinysocketarraytype.html index b61a1ab..c51b212 100644 --- a/docs/enums/destinysocketarraytype.html +++ b/docs/enums/destinysocketarraytype.html @@ -66,6 +66,18 @@

    Enumeration DestinySocketArrayType

    +
    +
    +
    +

    If you look in the DestinyInventoryItemDefinition's "sockets" property, you'll + see that there are two types of sockets: intrinsic, and "socketEntry."

    +
    +

    Unfortunately, because Intrinsic sockets are a whole separate array, it is no + longer sufficient to know the index into that array to know which socket we're + talking about. You have to know whether it's in the default "socketEntries" or + if it's in the "intrinsic" list.

    +
    +

    Index

    @@ -88,7 +100,7 @@

    Default

    Default: = 0
    @@ -98,7 +110,7 @@

    Intrinsic

    Intrinsic: = 1
    diff --git a/docs/enums/destinysocketcategorystyle.html b/docs/enums/destinysocketcategorystyle.html index dd884a6..241fb9e 100644 --- a/docs/enums/destinysocketcategorystyle.html +++ b/docs/enums/destinysocketcategorystyle.html @@ -66,6 +66,14 @@

    Enumeration DestinySocketCategoryStyle

    +
    +
    +
    +

    Represents the possible and known UI styles used by the game for rendering + Socket Categories.

    +
    +
    +

    Index

    @@ -91,7 +99,7 @@

    Consumable

    Consumable: = 2
    @@ -101,7 +109,7 @@

    Intrinsic

    Intrinsic: = 4
    @@ -111,7 +119,7 @@

    Reusable

    Reusable: = 1
    @@ -121,7 +129,7 @@

    Unknown

    Unknown: = 0
    @@ -131,7 +139,7 @@

    Unlockable

    Unlockable: = 3
    diff --git a/docs/enums/destinysocketvisibility.html b/docs/enums/destinysocketvisibility.html index bce97b9..54a5b3e 100644 --- a/docs/enums/destinysocketvisibility.html +++ b/docs/enums/destinysocketvisibility.html @@ -90,7 +90,7 @@

    Hidden

    Hidden: = 1
    @@ -100,7 +100,7 @@

    HiddenIfNoPlugsAvailable

    HiddenIfNoPlugsAvailable: = 3
    @@ -110,7 +110,7 @@

    HiddenWhenEmpty

    HiddenWhenEmpty: = 2
    @@ -120,7 +120,7 @@

    Visible

    Visible: = 0
    diff --git a/docs/enums/destinystataggregationtype.html b/docs/enums/destinystataggregationtype.html index 1dc1b69..85a571a 100644 --- a/docs/enums/destinystataggregationtype.html +++ b/docs/enums/destinystataggregationtype.html @@ -66,6 +66,22 @@

    Enumeration DestinyStatAggregationType

    +
    +
    +
    +

    When a Stat (DestinyStatDefinition) is aggregated, this is the rules used for + determining the level and formula used for aggregation.

    +
    +
      +
    • CharacterAverage = apply a weighted average using the related + DestinyStatGroupDefinition on the DestinyInventoryItemDefinition across the + character's equipped items. See both of those definitions for details. * + Character = don't aggregate: the stat should be located and used directly on the + character. * Item = don't aggregate: the stat should be located and used + directly on the item.
    • +
    +
    +

    Index

    @@ -89,7 +105,7 @@

    Character

    Character: = 1
    @@ -99,7 +115,7 @@

    CharacterAverage

    CharacterAverage: = 0
    @@ -109,7 +125,7 @@

    Item

    Item: = 2
    diff --git a/docs/enums/destinystatcategory.html b/docs/enums/destinystatcategory.html index 409651d..1004990 100644 --- a/docs/enums/destinystatcategory.html +++ b/docs/enums/destinystatcategory.html @@ -66,6 +66,13 @@

    Enumeration DestinyStatCategory

    +
    +
    +
    +

    At last, stats have categories. Use this for whatever purpose you might wish.

    +
    +
    +

    Index

    @@ -90,7 +97,7 @@

    Defense

    Defense: = 2
    @@ -100,7 +107,7 @@

    Gameplay

    Gameplay: = 0
    @@ -110,7 +117,7 @@

    Primary

    Primary: = 3
    @@ -120,7 +127,7 @@

    Weapon

    Weapon: = 1
    diff --git a/docs/enums/destinystatscategorytype.html b/docs/enums/destinystatscategorytype.html index 27a565a..3164af4 100644 --- a/docs/enums/destinystatscategorytype.html +++ b/docs/enums/destinystatscategorytype.html @@ -102,7 +102,7 @@

    Assists

    Assists: = 2
    @@ -112,7 +112,7 @@

    Criticals

    Criticals: = 4
    @@ -122,7 +122,7 @@

    Deaths

    Deaths: = 3
    @@ -132,7 +132,7 @@

    Entered

    Entered: = 8
    @@ -142,7 +142,7 @@

    KD

    KD: = 6
    @@ -152,7 +152,7 @@

    KDa

    KDa: = 5
    @@ -162,7 +162,7 @@

    Kills

    Kills: = 1
    @@ -172,7 +172,7 @@

    MedalAbilities

    MedalAbilities: = 15
    @@ -182,7 +182,7 @@

    MedalGame

    MedalGame: = 11
    @@ -192,7 +192,7 @@

    MedalMultiKills

    MedalMultiKills: = 14
    @@ -202,7 +202,7 @@

    MedalSpecialKills

    MedalSpecialKills: = 12
    @@ -212,7 +212,7 @@

    MedalSprees

    MedalSprees: = 13
    @@ -222,7 +222,7 @@

    MedalWins

    MedalWins: = 10
    @@ -232,7 +232,7 @@

    None

    None: = 0
    @@ -242,7 +242,7 @@

    Score

    Score: = 7
    @@ -252,7 +252,7 @@

    TimePlayed

    TimePlayed: = 9
    diff --git a/docs/enums/destinystatsgrouptype.html b/docs/enums/destinystatsgrouptype.html index 47ab171..94189df 100644 --- a/docs/enums/destinystatsgrouptype.html +++ b/docs/enums/destinystatsgrouptype.html @@ -66,6 +66,15 @@

    Enumeration DestinyStatsGroupType

    +
    +
    +
    +

    If the enum value is > 100, it is a "special" group that cannot be queried for + directly (special cases apply to when they are returned, and are not relevant in + general cases)

    +
    +
    +

    Index

    @@ -95,7 +104,7 @@

    Activity

    Activity: = 102
    @@ -110,7 +119,7 @@

    General

    General: = 1
    @@ -120,7 +129,7 @@

    Internal

    Internal: = 104
    @@ -130,7 +139,7 @@

    Leaderboard

    Leaderboard: = 101
    @@ -145,7 +154,7 @@

    Medals

    Medals: = 3
    @@ -155,7 +164,7 @@

    None

    None: = 0
    @@ -165,7 +174,7 @@

    ReservedGroups

    ReservedGroups: = 100
    @@ -182,7 +191,7 @@

    UniqueWeapon

    UniqueWeapon: = 103
    @@ -197,7 +206,7 @@

    Weapons

    Weapons: = 2
    diff --git a/docs/enums/destinytalentnodestate.html b/docs/enums/destinytalentnodestate.html index 71389f3..990f69c 100644 --- a/docs/enums/destinytalentnodestate.html +++ b/docs/enums/destinytalentnodestate.html @@ -100,7 +100,7 @@

    CanUpgrade

    CanUpgrade: = 1
    @@ -110,7 +110,7 @@

    Complete

    Complete: = 10
    @@ -120,7 +120,7 @@

    CreationOnly

    CreationOnly: = 12
    @@ -130,7 +130,7 @@

    Hidden

    Hidden: = 13
    @@ -140,7 +140,7 @@

    Invalid

    Invalid: = 0
    @@ -150,7 +150,7 @@

    MustSwap

    MustSwap: = 9
    @@ -160,7 +160,7 @@

    NoGridLevel

    NoGridLevel: = 7
    @@ -170,7 +170,7 @@

    NoMaterial

    NoMaterial: = 6
    @@ -180,7 +180,7 @@

    NoPoints

    NoPoints: = 2
    @@ -190,7 +190,7 @@

    NoPrerequisites

    NoPrerequisites: = 3
    @@ -200,7 +200,7 @@

    NoSteps

    NoSteps: = 4
    @@ -210,7 +210,7 @@

    NoUnlock

    NoUnlock: = 5
    @@ -220,7 +220,7 @@

    SwappingLocked

    SwappingLocked: = 8
    @@ -230,7 +230,7 @@

    Unknown

    Unknown: = 11
    diff --git a/docs/enums/destinytalentnodestepdamagetypes.html b/docs/enums/destinytalentnodestepdamagetypes.html index 8c72320..b33f06d 100644 --- a/docs/enums/destinytalentnodestepdamagetypes.html +++ b/docs/enums/destinytalentnodestepdamagetypes.html @@ -66,6 +66,14 @@

    Enumeration DestinyTalentNodeStepDamageTypes

    +
    +
    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +
    +

    Index

    @@ -92,7 +100,7 @@

    All

    All: = 15
    @@ -102,7 +110,7 @@

    Arc

    Arc: = 2
    @@ -112,7 +120,7 @@

    Kinetic

    Kinetic: = 1
    @@ -122,7 +130,7 @@

    None

    None: = 0
    @@ -132,7 +140,7 @@

    Solar

    Solar: = 4
    @@ -142,7 +150,7 @@

    Void

    Void: = 8
    diff --git a/docs/enums/destinytalentnodestepguardianattributes.html b/docs/enums/destinytalentnodestepguardianattributes.html index a662006..0d12492 100644 --- a/docs/enums/destinytalentnodestepguardianattributes.html +++ b/docs/enums/destinytalentnodestepguardianattributes.html @@ -66,6 +66,14 @@

    Enumeration DestinyTalentNodeStepGuardianAttributes

    +
    +
    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +
    +

    Index

    @@ -96,7 +104,7 @@

    AimUnderFire

    AimUnderFire: = 16
    @@ -106,7 +114,7 @@

    All

    All: = 255
    @@ -116,7 +124,7 @@

    Health

    Health: = 4
    @@ -126,7 +134,7 @@

    Invisibility

    Invisibility: = 64
    @@ -136,7 +144,7 @@

    None

    None: = 0
    @@ -146,7 +154,7 @@

    Radar

    Radar: = 32
    @@ -156,7 +164,7 @@

    Reputations

    Reputations: = 128
    @@ -166,7 +174,7 @@

    Revive

    Revive: = 8
    @@ -176,7 +184,7 @@

    Shields

    Shields: = 2
    @@ -186,7 +194,7 @@

    Stats

    Stats: = 1
    diff --git a/docs/enums/destinytalentnodestepimpacteffects.html b/docs/enums/destinytalentnodestepimpacteffects.html index 301e764..de6caca 100644 --- a/docs/enums/destinytalentnodestepimpacteffects.html +++ b/docs/enums/destinytalentnodestepimpacteffects.html @@ -66,6 +66,14 @@

    Enumeration DestinyTalentNodeStepImpactEffects

    +
    +
    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +
    +

    Index

    @@ -94,7 +102,7 @@

    All

    All: = 63
    @@ -104,7 +112,7 @@

    ArmorPiercing

    ArmorPiercing: = 1
    @@ -114,7 +122,7 @@

    CollateralDamage

    CollateralDamage: = 8
    @@ -124,7 +132,7 @@

    Disorient

    Disorient: = 16
    @@ -134,7 +142,7 @@

    Flinch

    Flinch: = 4
    @@ -144,7 +152,7 @@

    HighlightTarget

    HighlightTarget: = 32
    @@ -154,7 +162,7 @@

    None

    None: = 0
    @@ -164,7 +172,7 @@

    Ricochet

    Ricochet: = 2
    diff --git a/docs/enums/destinytalentnodesteplightabilities.html b/docs/enums/destinytalentnodesteplightabilities.html index a0357f2..b4ac258 100644 --- a/docs/enums/destinytalentnodesteplightabilities.html +++ b/docs/enums/destinytalentnodesteplightabilities.html @@ -66,6 +66,14 @@

    Enumeration DestinyTalentNodeStepLightAbilities

    +
    +
    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +
    +

    Index

    @@ -94,7 +102,7 @@

    All

    All: = 63
    @@ -104,7 +112,7 @@

    Grenades

    Grenades: = 1
    @@ -114,7 +122,7 @@

    Melee

    Melee: = 2
    @@ -124,7 +132,7 @@

    MovementModes

    MovementModes: = 4
    @@ -134,7 +142,7 @@

    None

    None: = 0
    @@ -144,7 +152,7 @@

    Orbs

    Orbs: = 8
    @@ -154,7 +162,7 @@

    SuperEnergy

    SuperEnergy: = 16
    @@ -164,7 +172,7 @@

    SuperMods

    SuperMods: = 32
    diff --git a/docs/enums/destinytalentnodestepweaponperformances.html b/docs/enums/destinytalentnodestepweaponperformances.html index 9d98f3c..8b98d3b 100644 --- a/docs/enums/destinytalentnodestepweaponperformances.html +++ b/docs/enums/destinytalentnodestepweaponperformances.html @@ -66,6 +66,14 @@

    Enumeration DestinyTalentNodeStepWeaponPerformances

    +
    +
    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +
    +

    Index

    @@ -101,7 +109,7 @@

    Accuracy

    Accuracy: = 4
    @@ -111,7 +119,7 @@

    All

    All: = 8191
    @@ -121,7 +129,7 @@

    AmmoAndMagazine

    AmmoAndMagazine: = 512
    @@ -131,7 +139,7 @@

    ChargeTime

    ChargeTime: = 4096
    @@ -141,7 +149,7 @@

    Damage

    Damage: = 2
    @@ -151,7 +159,7 @@

    HairTrigger

    HairTrigger: = 256
    @@ -161,7 +169,7 @@

    None

    None: = 0
    @@ -171,7 +179,7 @@

    Range

    Range: = 8
    @@ -181,7 +189,7 @@

    RateOfFire

    RateOfFire: = 1
    @@ -191,7 +199,7 @@

    Ready

    Ready: = 64
    @@ -201,7 +209,7 @@

    Recoil

    Recoil: = 32
    @@ -211,7 +219,7 @@

    Reload

    Reload: = 128
    @@ -221,7 +229,7 @@

    ShotgunSpread

    ShotgunSpread: = 2048
    @@ -231,7 +239,7 @@

    TrackingAndDetonation

    TrackingAndDetonation: = 1024
    @@ -241,7 +249,7 @@

    Zoom

    Zoom: = 16
    diff --git a/docs/enums/destinyunlockvalueuistyle.html b/docs/enums/destinyunlockvalueuistyle.html index e55d374..3bc7ff6 100644 --- a/docs/enums/destinyunlockvalueuistyle.html +++ b/docs/enums/destinyunlockvalueuistyle.html @@ -66,6 +66,15 @@

    Enumeration DestinyUnlockValueUIStyle

    +
    +
    +
    +

    If you're showing an unlock value in the UI, this is the format in which it + should be shown. You'll have to build your own algorithms on the client side to + determine how best to render these options.

    +
    +
    +

    Index

    @@ -96,7 +105,7 @@

    Automatic

    Automatic: = 0
    @@ -111,7 +120,7 @@

    Checkbox

    Checkbox: = 2
    @@ -127,7 +136,7 @@

    DateTime

    DateTime: = 4
    @@ -145,7 +154,7 @@

    Fraction

    Fraction: = 1
    @@ -162,7 +171,7 @@

    FractionFloat

    FractionFloat: = 5
    @@ -179,7 +188,7 @@

    Hidden

    Hidden: = 8
    @@ -195,7 +204,7 @@

    Integer

    Integer: = 6
    @@ -210,7 +219,7 @@

    Multiplier

    Multiplier: = 9
    @@ -220,7 +229,7 @@

    Percentage

    Percentage: = 3
    @@ -237,7 +246,7 @@

    TimeDuration

    TimeDuration: = 7
    diff --git a/docs/enums/destinyvendorinteractionrewardselection.html b/docs/enums/destinyvendorinteractionrewardselection.html index 03fcb17..7ffd040 100644 --- a/docs/enums/destinyvendorinteractionrewardselection.html +++ b/docs/enums/destinyvendorinteractionrewardselection.html @@ -66,6 +66,14 @@

    Enumeration DestinyVendorInteractionRewardSelection

    +
    +
    +
    +

    When a Vendor Interaction provides rewards, they'll either let you choose one or + let you have all of them. This determines which it will be.

    +
    +
    +

    Index

    @@ -89,7 +97,7 @@

    All

    All: = 2
    @@ -99,7 +107,7 @@

    None

    None: = 0
    @@ -109,7 +117,7 @@

    One

    One: = 1
    diff --git a/docs/enums/destinyvendoritemrefundpolicy.html b/docs/enums/destinyvendoritemrefundpolicy.html index 05f47d5..3969154 100644 --- a/docs/enums/destinyvendoritemrefundpolicy.html +++ b/docs/enums/destinyvendoritemrefundpolicy.html @@ -66,6 +66,13 @@

    Enumeration DestinyVendorItemRefundPolicy

    +
    +
    +
    +

    The action that happens when the user attempts to refund an item.

    +
    +
    +

    Index

    @@ -89,7 +96,7 @@

    DeletesItem

    DeletesItem: = 1
    @@ -99,7 +106,7 @@

    NotRefundable

    NotRefundable: = 0
    @@ -109,7 +116,7 @@

    RevokesLicense

    RevokesLicense: = 2
    diff --git a/docs/enums/destinyvendoritemstate.html b/docs/enums/destinyvendoritemstate.html index 36bec29..53a4604 100644 --- a/docs/enums/destinyvendoritemstate.html +++ b/docs/enums/destinyvendoritemstate.html @@ -66,6 +66,17 @@

    Enumeration DestinyVendorItemState

    +
    +
    +
    +

    The possible states of Destiny Profile Records. IMPORTANT: Any given item can + theoretically have many of these states simultaneously: as a result, this was + altered to be a flags enumeration/bitmask for v3.2.0.

    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +

    Index

    @@ -97,7 +108,7 @@

    Complete

    Complete: = 4
    @@ -113,7 +124,7 @@

    Ending

    Ending: = 32
    @@ -128,7 +139,7 @@

    Featured

    Featured: = 16
    @@ -144,7 +155,7 @@

    Incomplete

    Incomplete: = 1
    @@ -161,7 +172,7 @@

    New

    New: = 8
    @@ -177,7 +188,7 @@

    NexusAttention

    NexusAttention: = 512
    @@ -194,7 +205,7 @@

    None

    None: = 0
    @@ -209,7 +220,7 @@

    OnSale

    OnSale: = 64
    @@ -224,7 +235,7 @@

    Owned

    Owned: = 128
    @@ -239,7 +250,7 @@

    RewardAvailable

    RewardAvailable: = 2
    @@ -255,7 +266,7 @@

    WideView

    WideView: = 256
    diff --git a/docs/enums/destinyvendorreplytype.html b/docs/enums/destinyvendorreplytype.html index 223e55c..9f0766a 100644 --- a/docs/enums/destinyvendorreplytype.html +++ b/docs/enums/destinyvendorreplytype.html @@ -66,6 +66,13 @@

    Enumeration DestinyVendorReplyType

    +
    +
    +
    +

    This determines the type of reply that a Vendor will have during an Interaction.

    +
    +
    +

    Index

    @@ -89,7 +96,7 @@

    Accept

    Accept: = 0
    @@ -99,7 +106,7 @@

    Complete

    Complete: = 2
    @@ -109,7 +116,7 @@

    Decline

    Decline: = 1
    diff --git a/docs/enums/developerrole.html b/docs/enums/developerrole.html index 0bcaeb2..fa52469 100644 --- a/docs/enums/developerrole.html +++ b/docs/enums/developerrole.html @@ -89,7 +89,7 @@

    None

    None: = 0
    @@ -99,7 +99,7 @@

    Owner

    Owner: = 1
    @@ -109,7 +109,7 @@

    TeamMember

    TeamMember: = 2
    diff --git a/docs/enums/equipfailurereason.html b/docs/enums/equipfailurereason.html index 5fc2255..41efca5 100644 --- a/docs/enums/equipfailurereason.html +++ b/docs/enums/equipfailurereason.html @@ -66,6 +66,16 @@

    Enumeration EquipFailureReason

    +
    +
    +
    +

    The reasons why an item cannot be equipped, if any. Many flags can be set, or " + None" if

    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +

    Index

    @@ -92,7 +102,7 @@

    ItemFailedLevelCheck

    ItemFailedLevelCheck: = 8
    @@ -108,7 +118,7 @@

    ItemFailedUnlockCheck

    ItemFailedUnlockCheck: = 4
    @@ -128,7 +138,7 @@

    ItemNotOnCharacter

    ItemNotOnCharacter: = 16
    @@ -145,7 +155,7 @@

    ItemUnequippable

    ItemUnequippable: = 1
    @@ -161,7 +171,7 @@

    ItemUniqueEquipRestricted

    ItemUniqueEquipRestricted: = 2
    @@ -178,7 +188,7 @@

    None

    None: = 0
    diff --git a/docs/enums/equippingitemblockattributes.html b/docs/enums/equippingitemblockattributes.html index 712af75..51e8ba9 100644 --- a/docs/enums/equippingitemblockattributes.html +++ b/docs/enums/equippingitemblockattributes.html @@ -66,6 +66,14 @@

    Enumeration EquippingItemBlockAttributes

    +
    +
    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +
    +

    Index

    @@ -88,7 +96,7 @@

    EquipOnAcquire

    EquipOnAcquire: = 1
    @@ -98,7 +106,7 @@

    None

    None: = 0
    diff --git a/docs/enums/fireteamactivitytype.html b/docs/enums/fireteamactivitytype.html index 056ba0e..d1fbe5d 100644 --- a/docs/enums/fireteamactivitytype.html +++ b/docs/enums/fireteamactivitytype.html @@ -82,6 +82,7 @@

    Enumeration members

  • Gambit
  • Nightfall
  • Raid
  • +
  • Reckoning
  • Trials
  • @@ -96,7 +97,7 @@

    All

    All: = 0
    @@ -106,7 +107,7 @@

    Anything

    Anything: = 5
    @@ -116,7 +117,7 @@

    BlindWell

    BlindWell: = 7
    @@ -126,7 +127,7 @@

    Crucible

    Crucible: = 2
    @@ -136,7 +137,7 @@

    EscalationProtocol

    EscalationProtocol: = 8
    @@ -146,7 +147,7 @@

    Forge

    Forge: = 9
    @@ -156,7 +157,7 @@

    Gambit

    Gambit: = 6
    @@ -166,7 +167,7 @@

    Nightfall

    Nightfall: = 4
    @@ -176,7 +177,17 @@

    Raid

    Raid: = 1
    + +
    + +

    Reckoning

    +
    Reckoning: = 10
    +
    @@ -186,7 +197,7 @@

    Trials

    Trials: = 3
    @@ -234,6 +245,9 @@

    Trials

  • Raid
  • +
  • + Reckoning +
  • Trials
  • diff --git a/docs/enums/fireteamdaterange.html b/docs/enums/fireteamdaterange.html index 62e891d..bad4eaf 100644 --- a/docs/enums/fireteamdaterange.html +++ b/docs/enums/fireteamdaterange.html @@ -91,7 +91,7 @@

    All

    All: = 0
    @@ -101,7 +101,7 @@

    FortyEightHours

    FortyEightHours: = 3
    @@ -111,7 +111,7 @@

    Now

    Now: = 1
    @@ -121,7 +121,7 @@

    ThisWeek

    ThisWeek: = 4
    @@ -131,7 +131,7 @@

    TwentyFourHours

    TwentyFourHours: = 2
    diff --git a/docs/enums/fireteamplatform.html b/docs/enums/fireteamplatform.html index 8f5178b..2f54ddb 100644 --- a/docs/enums/fireteamplatform.html +++ b/docs/enums/fireteamplatform.html @@ -90,7 +90,7 @@

    Blizzard

    Blizzard: = 3
    @@ -100,7 +100,7 @@

    Playstation4

    Playstation4: = 1
    @@ -110,7 +110,7 @@

    Unknown

    Unknown: = 0
    @@ -120,7 +120,7 @@

    XboxOne

    XboxOne: = 2
    diff --git a/docs/enums/fireteamplatforminviteresult.html b/docs/enums/fireteamplatforminviteresult.html index c0150c0..ae7500b 100644 --- a/docs/enums/fireteamplatforminviteresult.html +++ b/docs/enums/fireteamplatforminviteresult.html @@ -91,7 +91,7 @@

    AlreadyInFireteam

    AlreadyInFireteam: = 2
    @@ -101,7 +101,7 @@

    None

    None: = 0
    @@ -111,7 +111,7 @@

    ServiceError

    ServiceError: = 4
    @@ -121,7 +121,7 @@

    Success

    Success: = 1
    @@ -131,7 +131,7 @@

    Throttled

    Throttled: = 3
    diff --git a/docs/enums/fireteampublicsearchoption.html b/docs/enums/fireteampublicsearchoption.html index 55bd787..87f33c8 100644 --- a/docs/enums/fireteampublicsearchoption.html +++ b/docs/enums/fireteampublicsearchoption.html @@ -89,7 +89,7 @@

    PrivateOnly

    PrivateOnly: = 2
    @@ -99,7 +99,7 @@

    PublicAndPrivate

    PublicAndPrivate: = 0
    @@ -109,7 +109,7 @@

    PublicOnly

    PublicOnly: = 1
    diff --git a/docs/enums/fireteamslotsearch.html b/docs/enums/fireteamslotsearch.html index 95d58bb..5cc2a37 100644 --- a/docs/enums/fireteamslotsearch.html +++ b/docs/enums/fireteamslotsearch.html @@ -89,7 +89,7 @@

    HasOpenPlayerOrAltSlots

    HasOpenPlayerOrAltSlots: = 2
    @@ -99,7 +99,7 @@

    HasOpenPlayerSlots

    HasOpenPlayerSlots: = 1
    @@ -109,7 +109,7 @@

    NoSlotRestriction

    NoSlotRestriction: = 0
    diff --git a/docs/enums/forummediatype.html b/docs/enums/forummediatype.html index 9951d3a..faa2541 100644 --- a/docs/enums/forummediatype.html +++ b/docs/enums/forummediatype.html @@ -90,7 +90,7 @@

    Image

    Image: = 1
    @@ -100,7 +100,7 @@

    None

    None: = 0
    @@ -110,7 +110,7 @@

    Video

    Video: = 2
    @@ -120,7 +120,7 @@

    Youtube

    Youtube: = 3
    diff --git a/docs/enums/forumpostpopularity.html b/docs/enums/forumpostpopularity.html index 4e67203..d938892 100644 --- a/docs/enums/forumpostpopularity.html +++ b/docs/enums/forumpostpopularity.html @@ -92,7 +92,7 @@

    CoolStory

    CoolStory: = 3
    @@ -102,7 +102,7 @@

    Default

    Default: = 1
    @@ -112,7 +112,7 @@

    Discussed

    Discussed: = 2
    @@ -122,7 +122,7 @@

    Empty

    Empty: = 0
    @@ -132,7 +132,7 @@

    HeatingUp

    HeatingUp: = 4
    @@ -142,7 +142,7 @@

    Hot

    Hot: = 5
    diff --git a/docs/enums/forumpostsortenum.html b/docs/enums/forumpostsortenum.html index 1b9ddf6..ca9b29d 100644 --- a/docs/enums/forumpostsortenum.html +++ b/docs/enums/forumpostsortenum.html @@ -88,7 +88,7 @@

    Default

    Default: = 0
    @@ -98,7 +98,7 @@

    OldestFirst

    OldestFirst: = 1
    diff --git a/docs/enums/forumrecruitmentintensitylabel.html b/docs/enums/forumrecruitmentintensitylabel.html index 00aafd1..2f2e52e 100644 --- a/docs/enums/forumrecruitmentintensitylabel.html +++ b/docs/enums/forumrecruitmentintensitylabel.html @@ -89,7 +89,7 @@

    Casual

    Casual: = 1
    @@ -99,7 +99,7 @@

    None

    None: = 0
    @@ -109,7 +109,7 @@

    Professional

    Professional: = 2
    diff --git a/docs/enums/forumrecruitmenttonelabel.html b/docs/enums/forumrecruitmenttonelabel.html index 05a17d8..61b7b3f 100644 --- a/docs/enums/forumrecruitmenttonelabel.html +++ b/docs/enums/forumrecruitmenttonelabel.html @@ -89,7 +89,7 @@

    FamilyFriendly

    FamilyFriendly: = 1
    @@ -99,7 +99,7 @@

    None

    None: = 0
    @@ -109,7 +109,7 @@

    Rowdy

    Rowdy: = 2
    diff --git a/docs/enums/forumtopicscategoryfiltersenum.html b/docs/enums/forumtopicscategoryfiltersenum.html index 9e7d661..34f8cdd 100644 --- a/docs/enums/forumtopicscategoryfiltersenum.html +++ b/docs/enums/forumtopicscategoryfiltersenum.html @@ -66,6 +66,14 @@

    Enumeration ForumTopicsCategoryFiltersEnum

    +
    +
    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +
    +

    Index

    @@ -95,7 +103,7 @@

    Announcement

    Announcement: = 32
    @@ -105,7 +113,7 @@

    AnsweredQuestions

    AnsweredQuestions: = 4
    @@ -115,7 +123,7 @@

    BungieOfficial

    BungieOfficial: = 64
    @@ -125,7 +133,7 @@

    Links

    Links: = 1
    @@ -135,7 +143,7 @@

    Media

    Media: = 8
    @@ -145,7 +153,7 @@

    None

    None: = 0
    @@ -155,7 +163,7 @@

    Polls

    Polls: = 128
    @@ -165,7 +173,7 @@

    Questions

    Questions: = 2
    @@ -175,7 +183,7 @@

    TextOnly

    TextOnly: = 16
    diff --git a/docs/enums/forumtopicsquickdateenum.html b/docs/enums/forumtopicsquickdateenum.html index d6dd858..6d070ba 100644 --- a/docs/enums/forumtopicsquickdateenum.html +++ b/docs/enums/forumtopicsquickdateenum.html @@ -91,7 +91,7 @@

    All

    All: = 0
    @@ -101,7 +101,7 @@

    LastDay

    LastDay: = 4
    @@ -111,7 +111,7 @@

    LastMonth

    LastMonth: = 2
    @@ -121,7 +121,7 @@

    LastWeek

    LastWeek: = 3
    @@ -131,7 +131,7 @@

    LastYear

    LastYear: = 1
    diff --git a/docs/enums/forumtopicssortenum.html b/docs/enums/forumtopicssortenum.html index 9a28e9e..78e25b7 100644 --- a/docs/enums/forumtopicssortenum.html +++ b/docs/enums/forumtopicssortenum.html @@ -94,7 +94,7 @@

    Controversiality

    Controversiality: = 4
    @@ -104,7 +104,7 @@

    Default

    Default: = 0
    @@ -114,7 +114,7 @@

    HighestRated

    HighestRated: = 6
    @@ -124,7 +124,7 @@

    LastReplied

    LastReplied: = 1
    @@ -134,7 +134,7 @@

    Liked

    Liked: = 5
    @@ -144,7 +144,7 @@

    MostReplied

    MostReplied: = 2
    @@ -154,7 +154,7 @@

    MostUpvoted

    MostUpvoted: = 7
    @@ -164,7 +164,7 @@

    Popularity

    Popularity: = 3
    diff --git a/docs/enums/globalalertlevel.html b/docs/enums/globalalertlevel.html index b4804be..b25a382 100644 --- a/docs/enums/globalalertlevel.html +++ b/docs/enums/globalalertlevel.html @@ -101,7 +101,7 @@

    Blue

    Blue: = 1
    @@ -111,7 +111,7 @@

    Red

    Red: = 3
    @@ -121,7 +121,7 @@

    Unkown

    Unkown: = 0
    @@ -131,7 +131,7 @@

    Yellow

    Yellow: = 2
    diff --git a/docs/enums/globalalerttype.html b/docs/enums/globalalerttype.html index 300a657..764adce 100644 --- a/docs/enums/globalalerttype.html +++ b/docs/enums/globalalerttype.html @@ -99,7 +99,7 @@

    GlobalAlert

    GlobalAlert: = 0
    @@ -109,7 +109,7 @@

    StreamingAlert

    StreamingAlert: = 1
    diff --git a/docs/enums/groupalliancestatus.html b/docs/enums/groupalliancestatus.html index 81796b7..b22a8ba 100644 --- a/docs/enums/groupalliancestatus.html +++ b/docs/enums/groupalliancestatus.html @@ -89,7 +89,7 @@

    Child

    Child: = 2
    @@ -99,7 +99,7 @@

    Parent

    Parent: = 1
    @@ -109,7 +109,7 @@

    Unallied

    Unallied: = 0
    diff --git a/docs/enums/groupapplicationresolvestate.html b/docs/enums/groupapplicationresolvestate.html index 0f3c19f..d50d5a1 100644 --- a/docs/enums/groupapplicationresolvestate.html +++ b/docs/enums/groupapplicationresolvestate.html @@ -90,7 +90,7 @@

    Accepted

    Accepted: = 1
    @@ -100,7 +100,7 @@

    Denied

    Denied: = 2
    @@ -110,7 +110,7 @@

    Rescinded

    Rescinded: = 3
    @@ -120,7 +120,7 @@

    Unresolved

    Unresolved: = 0
    diff --git a/docs/enums/groupdaterange.html b/docs/enums/groupdaterange.html index 58fc5bc..a97f291 100644 --- a/docs/enums/groupdaterange.html +++ b/docs/enums/groupdaterange.html @@ -91,7 +91,7 @@

    All

    All: = 0
    @@ -101,7 +101,7 @@

    PastDay

    PastDay: = 1
    @@ -111,7 +111,7 @@

    PastMonth

    PastMonth: = 3
    @@ -121,7 +121,7 @@

    PastWeek

    PastWeek: = 2
    @@ -131,7 +131,7 @@

    PastYear

    PastYear: = 4
    diff --git a/docs/enums/grouphomepage.html b/docs/enums/grouphomepage.html index ae15bb4..e65573c 100644 --- a/docs/enums/grouphomepage.html +++ b/docs/enums/grouphomepage.html @@ -89,7 +89,7 @@

    AllianceForum

    AllianceForum: = 2
    @@ -99,7 +99,7 @@

    Forum

    Forum: = 1
    @@ -109,7 +109,7 @@

    Wall

    Wall: = 0
    diff --git a/docs/enums/grouppostpublicity.html b/docs/enums/grouppostpublicity.html index dff57c6..6d3bd7a 100644 --- a/docs/enums/grouppostpublicity.html +++ b/docs/enums/grouppostpublicity.html @@ -89,7 +89,7 @@

    Alliance

    Alliance: = 1
    @@ -99,7 +99,7 @@

    Private

    Private: = 2
    @@ -109,7 +109,7 @@

    Public

    Public: = 0
    diff --git a/docs/enums/grouppotentialmemberstatus.html b/docs/enums/grouppotentialmemberstatus.html index 05219e9..8828d9b 100644 --- a/docs/enums/grouppotentialmemberstatus.html +++ b/docs/enums/grouppotentialmemberstatus.html @@ -89,7 +89,7 @@

    Applicant

    Applicant: = 1
    @@ -99,7 +99,7 @@

    Invitee

    Invitee: = 2
    @@ -109,7 +109,7 @@

    None

    None: = 0
    diff --git a/docs/enums/groupsformemberfilter.html b/docs/enums/groupsformemberfilter.html index a8c5017..23ab800 100644 --- a/docs/enums/groupsformemberfilter.html +++ b/docs/enums/groupsformemberfilter.html @@ -89,7 +89,7 @@

    All

    All: = 0
    @@ -99,7 +99,7 @@

    Founded

    Founded: = 1
    @@ -109,7 +109,7 @@

    NonFounded

    NonFounded: = 2
    diff --git a/docs/enums/groupsortby.html b/docs/enums/groupsortby.html index 9b55a29..060480e 100644 --- a/docs/enums/groupsortby.html +++ b/docs/enums/groupsortby.html @@ -90,7 +90,7 @@

    Date

    Date: = 1
    @@ -100,7 +100,7 @@

    Id

    Id: = 3
    @@ -110,7 +110,7 @@

    Name

    Name: = 0
    @@ -120,7 +120,7 @@

    Popularity

    Popularity: = 2
    diff --git a/docs/enums/grouptype.html b/docs/enums/grouptype.html index fbd0386..ebc3ee9 100644 --- a/docs/enums/grouptype.html +++ b/docs/enums/grouptype.html @@ -88,7 +88,7 @@

    Clan

    Clan: = 1
    @@ -98,7 +98,7 @@

    General

    General: = 0
    diff --git a/docs/enums/hostguidedgamespermissionlevel.html b/docs/enums/hostguidedgamespermissionlevel.html index cfa889b..657e265 100644 --- a/docs/enums/hostguidedgamespermissionlevel.html +++ b/docs/enums/hostguidedgamespermissionlevel.html @@ -66,6 +66,14 @@

    Enumeration HostGuidedGamesPermissionLevel

    +
    +
    +
    +

    Used for setting the guided game permission level override (admins and founders + can always host guided games).

    +
    +
    +

    Index

    @@ -89,7 +97,7 @@

    Beginner

    Beginner: = 1
    @@ -99,7 +107,7 @@

    Member

    Member: = 2
    @@ -109,7 +117,7 @@

    None

    None: = 0
    diff --git a/docs/enums/ignorelength.html b/docs/enums/ignorelength.html index c6db63d..2704c9b 100644 --- a/docs/enums/ignorelength.html +++ b/docs/enums/ignorelength.html @@ -98,7 +98,7 @@

    Forever

    Forever: = 8
    @@ -108,7 +108,7 @@

    Hour

    Hour: = 10
    @@ -118,7 +118,7 @@

    Month

    Month: = 4
    @@ -128,7 +128,7 @@

    None

    None: = 0
    @@ -138,7 +138,7 @@

    SixMonths

    SixMonths: = 6
    @@ -148,7 +148,7 @@

    ThirtyDays

    ThirtyDays: = 11
    @@ -158,7 +158,7 @@

    ThreeMinutes

    ThreeMinutes: = 9
    @@ -168,7 +168,7 @@

    ThreeMonths

    ThreeMonths: = 5
    @@ -178,7 +178,7 @@

    ThreeWeeks

    ThreeWeeks: = 3
    @@ -188,7 +188,7 @@

    TwoWeeks

    TwoWeeks: = 2
    @@ -198,7 +198,7 @@

    Week

    Week: = 1
    @@ -208,7 +208,7 @@

    Year

    Year: = 7
    diff --git a/docs/enums/ignorestatus.html b/docs/enums/ignorestatus.html index 808d4ed..35a802d 100644 --- a/docs/enums/ignorestatus.html +++ b/docs/enums/ignorestatus.html @@ -66,6 +66,14 @@

    Enumeration IgnoreStatus

    +
    +
    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +
    +

    Index

    @@ -93,7 +101,7 @@

    IgnoredByGroup

    IgnoredByGroup: = 4
    @@ -103,7 +111,7 @@

    IgnoredGlobal

    IgnoredGlobal: = 32
    @@ -113,7 +121,7 @@

    IgnoredGroup

    IgnoredGroup: = 2
    @@ -123,7 +131,7 @@

    IgnoredPost

    IgnoredPost: = 8
    @@ -133,7 +141,7 @@

    IgnoredTag

    IgnoredTag: = 16
    @@ -143,7 +151,7 @@

    IgnoredUser

    IgnoredUser: = 1
    @@ -153,7 +161,7 @@

    NotIgnored

    NotIgnored: = 0
    diff --git a/docs/enums/itembindstatus.html b/docs/enums/itembindstatus.html index 029d059..ae31f07 100644 --- a/docs/enums/itembindstatus.html +++ b/docs/enums/itembindstatus.html @@ -90,7 +90,7 @@

    BoundToAccount

    BoundToAccount: = 2
    @@ -100,7 +100,7 @@

    BoundToCharacter

    BoundToCharacter: = 1
    @@ -110,7 +110,7 @@

    BoundToGuild

    BoundToGuild: = 3
    @@ -120,7 +120,7 @@

    NotBound

    NotBound: = 0
    diff --git a/docs/enums/itemlocation.html b/docs/enums/itemlocation.html index 807309b..d03ae97 100644 --- a/docs/enums/itemlocation.html +++ b/docs/enums/itemlocation.html @@ -91,7 +91,7 @@

    Inventory

    Inventory: = 1
    @@ -101,7 +101,7 @@

    Postmaster

    Postmaster: = 4
    @@ -111,7 +111,7 @@

    Unknown

    Unknown: = 0
    @@ -121,7 +121,7 @@

    Vault

    Vault: = 2
    @@ -131,7 +131,7 @@

    Vendor

    Vendor: = 3
    diff --git a/docs/enums/itemperkvisibility.html b/docs/enums/itemperkvisibility.html index 75e2755..34b5d04 100644 --- a/docs/enums/itemperkvisibility.html +++ b/docs/enums/itemperkvisibility.html @@ -66,6 +66,15 @@

    Enumeration ItemPerkVisibility

    +
    +
    +
    +

    Indicates how a perk should be shown, or if it should be, in the game UI. Maybe + useful for those of you trying to filter out internal-use-only perks (or for + those of you trying to figure out what they do!)

    +
    +
    +

    Index

    @@ -89,7 +98,7 @@

    Disabled

    Disabled: = 1
    @@ -99,7 +108,7 @@

    Hidden

    Hidden: = 2
    @@ -109,7 +118,7 @@

    Visible

    Visible: = 0
    diff --git a/docs/enums/itemstate.html b/docs/enums/itemstate.html index 91eb984..06023f2 100644 --- a/docs/enums/itemstate.html +++ b/docs/enums/itemstate.html @@ -66,6 +66,17 @@

    Enumeration ItemState

    +
    +
    +
    +

    A flags enumeration/bitmask where each bit represents a different possible state + that the item can be in that may effect how the item is displayed to the user + and what actions can be performed against it.

    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +

    Index

    @@ -90,7 +101,7 @@

    Locked

    Locked: = 1
    @@ -106,7 +117,7 @@

    Masterwork

    Masterwork: = 4
    @@ -122,7 +133,7 @@

    None

    None: = 0
    @@ -132,7 +143,7 @@

    Tracked

    Tracked: = 2
    diff --git a/docs/enums/membershipoption.html b/docs/enums/membershipoption.html index 1076235..09c6b38 100644 --- a/docs/enums/membershipoption.html +++ b/docs/enums/membershipoption.html @@ -89,7 +89,7 @@

    Closed

    Closed: = 2
    @@ -99,7 +99,7 @@

    Open

    Open: = 1
    @@ -109,7 +109,7 @@

    Reviewed

    Reviewed: = 0
    diff --git a/docs/enums/oauthapplicationtype.html b/docs/enums/oauthapplicationtype.html index 832a50e..2ded39b 100644 --- a/docs/enums/oauthapplicationtype.html +++ b/docs/enums/oauthapplicationtype.html @@ -89,7 +89,7 @@

    Confidential

    Confidential: = 1
    @@ -105,7 +105,7 @@

    None

    None: = 0
    @@ -115,7 +115,7 @@

    Public

    Public: = 2
    diff --git a/docs/enums/partnershiptype.html b/docs/enums/partnershiptype.html index 15d1c16..a2739b4 100644 --- a/docs/enums/partnershiptype.html +++ b/docs/enums/partnershiptype.html @@ -66,6 +66,15 @@

    Enumeration PartnershipType

    +
    +
    +
    +

    Representing external partners to which BNet users can link accounts, but that + are not Account System credentials: partnerships that BNet uses exclusively for + data.

    +
    +
    +

    Index

    @@ -88,7 +97,7 @@

    None

    None: = 0
    @@ -98,7 +107,7 @@

    Twitch

    Twitch: = 1
    diff --git a/docs/enums/periodtype.html b/docs/enums/periodtype.html index d1a2f60..1570f77 100644 --- a/docs/enums/periodtype.html +++ b/docs/enums/periodtype.html @@ -90,7 +90,7 @@

    Activity

    Activity: = 3
    @@ -100,7 +100,7 @@

    AllTime

    AllTime: = 2
    @@ -110,7 +110,7 @@

    Daily

    Daily: = 1
    @@ -120,7 +120,7 @@

    None

    None: = 0
    diff --git a/docs/enums/platformerrorcodes.html b/docs/enums/platformerrorcodes.html index a5992ea..2477029 100644 --- a/docs/enums/platformerrorcodes.html +++ b/docs/enums/platformerrorcodes.html @@ -132,6 +132,7 @@

    Enumeration members

  • ClanFireteamAltFull
  • ClanFireteamBlocked
  • ClanFireteamCannotAdjustSlotCount
  • +
  • ClanFireteamExpired
  • ClanFireteamFull
  • ClanFireteamGameInvitesNotSupportForPlatform
  • ClanFireteamInvalidAuthContext
  • @@ -168,6 +169,7 @@

    Enumeration members

  • ClanNameNotValid
  • ClanNameNotValidError
  • ClanNameReserved
  • +
  • ClanNameRestricted
  • ClanNotEnabledAlreadyMemberOfAnotherClan
  • ClanNotEnabledForPlatform
  • ClanNotFound
  • @@ -671,6 +673,7 @@

    Enumeration members

  • TokenUnlockPartialFailure
  • TokenUserAgeNotVerified
  • TokenUserAlreadyOwnsOffer
  • +
  • TransactionEmailSendFailure
  • TransportException
  • TrendingCategoryNotFound
  • TrendingEntryTypeNotSupported
  • @@ -703,6 +706,8 @@

    Enumeration members

  • UserCreationDestinyMembershipRequired
  • UserDisplayNameMissingOrInvalid
  • UserEmailMissingOrInvalid
  • +
  • UserEmailValidationLimit
  • +
  • UserEmailValidationUnknown
  • UserFollowLimitExceeded
  • UserFriendsTokenNeedsRefresh
  • UserGenerateMobileKeyExistingSlotCollision
  • @@ -763,7 +768,7 @@

    AccessNotPermittedByApplicationScope

    AccessNotPermittedByApplicationScope: = 2108
    @@ -773,7 +778,7 @@

    AccessTokenHasExpired

    AccessTokenHasExpired: = 2111
    @@ -783,7 +788,7 @@

    ActivitiesParameterNull

    ActivitiesParameterNull: = 702
    @@ -793,7 +798,7 @@

    ActivitiesUnknownException

    ActivitiesUnknownException: = 701
    @@ -803,7 +808,7 @@

    ActivityCountsDiabled

    ActivityCountsDiabled: = 703
    @@ -813,7 +818,7 @@

    ActivityLoggingDisabled

    ActivityLoggingDisabled: = 707
    @@ -823,7 +828,7 @@

    ActivityPermissionDenied

    ActivityPermissionDenied: = 705
    @@ -833,7 +838,7 @@

    ActivitySearchInvalidParameters

    ActivitySearchInvalidParameters: = 704
    @@ -843,7 +848,7 @@

    AddSurveyAnswersUnknownSqlException

    AddSurveyAnswersUnknownSqlException: = 400
    @@ -853,7 +858,7 @@

    AllianceChildNotDefined

    AllianceChildNotDefined: = 671
    @@ -863,7 +868,7 @@

    AllianceOwnerCannotJoinAlliance

    AllianceOwnerCannotJoinAlliance: = 662
    @@ -873,7 +878,7 @@

    AllianceOwnerNotDefined

    AllianceOwnerNotDefined: = 670
    @@ -883,7 +888,7 @@

    AlreadyClanMemberOnPlatform

    AlreadyClanMemberOnPlatform: = 632
    @@ -893,7 +898,7 @@

    AlreadyRequestingMembershipForClanPlatform

    AlreadyRequestingMembershipForClanPlatform: = 631
    @@ -903,7 +908,7 @@

    ApiExceededMaxKeys

    ApiExceededMaxKeys: = 2100
    @@ -913,7 +918,7 @@

    ApiInvalidOrExpiredKey

    ApiInvalidOrExpiredKey: = 2101
    @@ -923,7 +928,7 @@

    ApiKeyMissingFromRequest

    ApiKeyMissingFromRequest: = 2102
    @@ -933,7 +938,7 @@

    ApplicationDisabled

    ApplicationDisabled: = 2103
    @@ -943,7 +948,7 @@

    ApplicationDisallowedByScope

    ApplicationDisallowedByScope: = 2105
    @@ -953,7 +958,7 @@

    ApplicationExceededMax

    ApplicationExceededMax: = 2104
    @@ -963,7 +968,7 @@

    ApplicationNameIsTaken

    ApplicationNameIsTaken: = 2109
    @@ -973,7 +978,7 @@

    ApplicationNotConfiguredForBungieAuth

    ApplicationNotConfiguredForBungieAuth: = 2113
    @@ -983,7 +988,7 @@

    ApplicationNotConfiguredForOAuth

    ApplicationNotConfiguredForOAuth: = 2114
    @@ -993,7 +998,7 @@

    ApplicationTokenFormatNotValid

    ApplicationTokenFormatNotValid: = 2112
    @@ -1003,7 +1008,7 @@

    AuthContextCacheAssertion

    AuthContextCacheAssertion: = 52
    @@ -1013,7 +1018,7 @@

    AuthTicketRequired

    AuthTicketRequired: = 95
    @@ -1023,7 +1028,7 @@

    AuthenticationInvalid

    AuthenticationInvalid: = 10
    @@ -1033,7 +1038,7 @@

    AuthorizationCodeInvalid

    AuthorizationCodeInvalid: = 2106
    @@ -1043,7 +1048,7 @@

    AwaRequestWasUnansweredForTooLong

    AwaRequestWasUnansweredForTooLong: = 2803
    @@ -1053,7 +1058,7 @@

    AwaTheFeatureRequiresARegisteredDevice

    AwaTheFeatureRequiresARegisteredDevice: = 2802
    @@ -1063,7 +1068,7 @@

    AwaTooManyPendingRequests

    AwaTooManyPendingRequests: = 2801
    @@ -1073,7 +1078,7 @@

    AwaTypeDisabled

    AwaTypeDisabled: = 2800
    @@ -1083,7 +1088,7 @@

    AwaWriteRequestMissingOrInvalidToken

    AwaWriteRequestMissingOrInvalidToken: = 2804
    @@ -1093,7 +1098,7 @@

    AwaWriteRequestTokenExpired

    AwaWriteRequestTokenExpired: = 2805
    @@ -1103,7 +1108,7 @@

    AwaWriteRequestTokenUsageLimitReached

    AwaWriteRequestTokenUsageLimitReached: = 2806
    @@ -1113,7 +1118,7 @@

    BadRequest

    BadRequest: = 9
    @@ -1123,7 +1128,7 @@

    BelowMinimumSuggestionLength

    BelowMinimumSuggestionLength: = 901
    @@ -1133,7 +1138,7 @@

    BungieNetAccountCreationRequired

    BungieNetAccountCreationRequired: = 98
    @@ -1143,7 +1148,7 @@

    BungieRewardEmailStateInvalid

    BungieRewardEmailStateInvalid: = 2049
    @@ -1153,7 +1158,7 @@

    BungieRewardNotYetClaimable

    BungieRewardNotYetClaimable: = 2050
    @@ -1163,7 +1168,7 @@

    CannotFollowSelf

    CannotFollowSelf: = 803
    @@ -1173,7 +1178,7 @@

    CannotGetSuggestionsOnMultipleTagsSimultaneouslyCannotGetSuggestionsOnMultipleTagsSimultaneously: = 902

    @@ -1183,7 +1188,7 @@

    CannotUseMobileAuthWithNonMobileProvider<
    CannotUseMobileAuthWithNonMobileProvider: = 92
    @@ -1193,7 +1198,7 @@

    ChildGroupAlreadyInAlliance

    ChildGroupAlreadyInAlliance: = 660
    @@ -1203,7 +1208,7 @@

    ChildGroupCannotInviteToAlliance

    ChildGroupCannotInviteToAlliance: = 664
    @@ -1213,7 +1218,7 @@

    ClanAlreadyEnabledForPlatform

    ClanAlreadyEnabledForPlatform: = 653
    @@ -1223,7 +1228,7 @@

    ClanApplicantInClanSoNowInvited

    ClanApplicantInClanSoNowInvited: = 699
    @@ -1233,7 +1238,7 @@

    ClanCallsignCannotStartOrEndWithWhiteSpac
    ClanCallsignCannotStartOrEndWithWhiteSpace: = 681
    @@ -1243,7 +1248,7 @@

    ClanCannotJoinNoCredential

    ClanCannotJoinNoCredential: = 657
    @@ -1253,7 +1258,7 @@

    ClanCannotSetTwoDefaultPostTypes

    ClanCannotSetTwoDefaultPostTypes: = 648
    @@ -1263,7 +1268,7 @@

    ClanCreationInWorldServerFailed

    ClanCreationInWorldServerFailed: = 685
    @@ -1273,7 +1278,7 @@

    ClanCultureIllegalCharacters

    ClanCultureIllegalCharacters: = 672
    @@ -1283,7 +1288,7 @@

    ClanEnabledButCouldNotJoinAlreadyMemberClanEnabledButCouldNotJoinAlreadyMember: = 656

    @@ -1293,7 +1298,7 @@

    ClanEnabledButCouldNotJoinNoAccount

    ClanEnabledButCouldNotJoinNoAccount: = 655
    @@ -1303,7 +1308,7 @@

    ClanFireteamAddNoAlternatesForImmediate

    ClanFireteamAddNoAlternatesForImmediate: = 3001
    @@ -1313,7 +1318,7 @@

    ClanFireteamAlreadyJoined

    ClanFireteamAlreadyJoined: = 3023
    @@ -1323,7 +1328,7 @@

    ClanFireteamAltFull

    ClanFireteamAltFull: = 3003
    @@ -1333,7 +1338,7 @@

    ClanFireteamBlocked

    ClanFireteamBlocked: = 3004
    @@ -1343,7 +1348,17 @@

    ClanFireteamCannotAdjustSlotCount

    ClanFireteamCannotAdjustSlotCount: = 3008
    + +
    + +

    ClanFireteamExpired

    +
    ClanFireteamExpired: = 3026
    +
    @@ -1353,7 +1368,7 @@

    ClanFireteamFull

    ClanFireteamFull: = 3002
    @@ -1363,7 +1378,7 @@

    ClanFireteamGameInvitesNotSupportForPlatf
    ClanFireteamGameInvitesNotSupportForPlatform: = 3011
    @@ -1373,7 +1388,7 @@

    ClanFireteamInvalidAuthContext

    ClanFireteamInvalidAuthContext: = 3013
    @@ -1383,7 +1398,7 @@

    ClanFireteamInvalidAuthProviderPsn

    ClanFireteamInvalidAuthProviderPsn: = 3014
    @@ -1393,7 +1408,7 @@

    ClanFireteamInvalidAuthToken

    ClanFireteamInvalidAuthToken: = 3016
    @@ -1403,7 +1418,7 @@

    ClanFireteamInvalidPlatform

    ClanFireteamInvalidPlatform: = 3007
    @@ -1413,7 +1428,7 @@

    ClanFireteamInvalidPlayerPlatform

    ClanFireteamInvalidPlayerPlatform: = 3009
    @@ -1423,7 +1438,7 @@

    ClanFireteamNonPublicMustHaveClan

    ClanFireteamNonPublicMustHaveClan: = 3021
    @@ -1433,7 +1448,7 @@

    ClanFireteamNotFound

    ClanFireteamNotFound: = 3000
    @@ -1443,7 +1458,7 @@

    ClanFireteamNotReadyForInvitesClosed

    ClanFireteamNotReadyForInvitesClosed: = 3019
    @@ -1453,7 +1468,7 @@

    ClanFireteamNotReadyForInvitesNotEnoughClanFireteamNotReadyForInvitesNotEnoughPlayers: = 3010

    @@ -1463,7 +1478,7 @@

    ClanFireteamNotReadyForInvitesNotSchedule
    ClanFireteamNotReadyForInvitesNotScheduledYet: = 3018
    @@ -1473,7 +1488,7 @@

    ClanFireteamPermissions

    ClanFireteamPermissions: = 3006
    @@ -1483,7 +1498,7 @@

    ClanFireteamPlatformInvitePreqFailure

    ClanFireteamPlatformInvitePreqFailure: = 3012
    @@ -1493,7 +1508,7 @@

    ClanFireteamPlayerEntryNotFound

    ClanFireteamPlayerEntryNotFound: = 3005
    @@ -1503,7 +1518,7 @@

    ClanFireteamPs4SessionFull

    ClanFireteamPs4SessionFull: = 3015
    @@ -1513,7 +1528,7 @@

    ClanFireteamPublicCreationRestriction

    ClanFireteamPublicCreationRestriction: = 3022
    @@ -1523,7 +1538,7 @@

    ClanFireteamPublicCreationRestrictionExtended

    ClanFireteamPublicCreationRestrictionExtended: = 3025
    @@ -1533,7 +1548,7 @@

    ClanFireteamScheduledFireteamsDisabled

    ClanFireteamScheduledFireteamsDisabled: = 3017
    @@ -1543,7 +1558,7 @@

    ClanFireteamScheduledFireteamsRange

    ClanFireteamScheduledFireteamsRange: = 3024
    @@ -1553,7 +1568,7 @@

    ClanFireteamScheduledFireteamsRequireAdminPerm
    ClanFireteamScheduledFireteamsRequireAdminPermissions: = 3020
    @@ -1563,7 +1578,7 @@

    ClanFounderCannotLeaveWithoutAbdication

    ClanFounderCannotLeaveWithoutAbdication: = 697
    @@ -1573,7 +1588,7 @@

    ClanInWrongStateForRequestedAction

    ClanInWrongStateForRequestedAction: = 690
    @@ -1583,7 +1598,7 @@

    ClanInfoCannotBeWhitespace

    ClanInfoCannotBeWhitespace: = 693
    @@ -1593,7 +1608,7 @@

    ClanInvalidOperation

    ClanInvalidOperation: = 696
    @@ -1603,7 +1618,7 @@

    ClanInviteAlreadyMember

    ClanInviteAlreadyMember: = 676
    @@ -1613,7 +1628,7 @@

    ClanMaximumMembershipReached

    ClanMaximumMembershipReached: = 667
    @@ -1623,7 +1638,7 @@

    ClanMemberNotFound

    ClanMemberNotFound: = 688
    @@ -1633,7 +1648,7 @@

    ClanMembershipClosed

    ClanMembershipClosed: = 675
    @@ -1643,7 +1658,7 @@

    ClanMembershipLevelDoesNotPermitThatActio
    ClanMembershipLevelDoesNotPermitThatAction: = 687
    @@ -1653,7 +1668,7 @@

    ClanMigrationFailed

    ClanMigrationFailed: = 682
    @@ -1663,7 +1678,7 @@

    ClanMissingMembershipApprovers

    ClanMissingMembershipApprovers: = 689
    @@ -1673,7 +1688,7 @@

    ClanNameAlreadyUsed

    ClanNameAlreadyUsed: = 691
    @@ -1683,7 +1698,7 @@

    ClanNameNotValid

    ClanNameNotValid: = 668
    @@ -1693,7 +1708,7 @@

    ClanNameNotValidError

    ClanNameNotValidError: = 669
    @@ -1703,7 +1718,17 @@

    ClanNameReserved

    ClanNameReserved: = 698
    + +
    + +

    ClanNameRestricted

    +
    ClanNameRestricted: = 751
    +
    @@ -1713,7 +1738,7 @@

    ClanNotEnabledAlreadyMemberOfAnotherClan

    ClanNotEnabledAlreadyMemberOfAnotherClan: = 683
    @@ -1723,7 +1748,7 @@

    ClanNotEnabledForPlatform

    ClanNotEnabledForPlatform: = 654
    @@ -1733,7 +1758,7 @@

    ClanNotFound

    ClanNotFound: = 686
    @@ -1743,7 +1768,7 @@

    ClanRequiresExistingDestinyAccount

    ClanRequiresExistingDestinyAccount: = 750
    @@ -1753,7 +1778,7 @@

    ClanRequiresInvitation

    ClanRequiresInvitation: = 674
    @@ -1763,7 +1788,7 @@

    ClanTagIllegalCharacters

    ClanTagIllegalCharacters: = 673
    @@ -1773,7 +1798,7 @@

    ClanTagRequired

    ClanTagRequired: = 679
    @@ -1783,7 +1808,7 @@

    ClanTargetDisallowsInvites

    ClanTargetDisallowsInvites: = 695
    @@ -1793,7 +1818,7 @@

    ClanTooFewMembers

    ClanTooFewMembers: = 692
    @@ -1803,7 +1828,7 @@

    CommunityStreamingUnavailable

    CommunityStreamingUnavailable: = 2300
    @@ -1813,7 +1838,7 @@

    ContentAssetZipCreationBusy

    ContentAssetZipCreationBusy: = 128
    @@ -1823,7 +1848,7 @@

    ContentAssetZipCreationFailure

    ContentAssetZipCreationFailure: = 127
    @@ -1833,7 +1858,7 @@

    ContentBabelCallFailed

    ContentBabelCallFailed: = 173
    @@ -1843,7 +1868,7 @@

    ContentCannotCreateDeploymentPackage

    ContentCannotCreateDeploymentPackage: = 164
    @@ -1853,7 +1878,7 @@

    ContentCannotCreateFile

    ContentCannotCreateFile: = 156
    @@ -1863,7 +1888,7 @@

    ContentCannotDeletePackage

    ContentCannotDeletePackage: = 134
    @@ -1873,7 +1898,7 @@

    ContentDeploymentPackageNotReadyError

    ContentDeploymentPackageNotReadyError: = 111
    @@ -1883,7 +1908,7 @@

    ContentEnglishPostLiveForbidden

    ContentEnglishPostLiveForbidden: = 174
    @@ -1893,7 +1918,7 @@

    ContentExternalFileCannotBeImportedLocally

    ContentExternalFileCannotBeImportedLocally: = 140
    @@ -1903,7 +1928,7 @@

    ContentFileUploadFailed

    ContentFileUploadFailed: = 136
    @@ -1913,7 +1938,7 @@

    ContentFolderNotFound

    ContentFolderNotFound: = 130
    @@ -1923,7 +1948,7 @@

    ContentIllegalBNetMembershipId

    ContentIllegalBNetMembershipId: = 171
    @@ -1933,7 +1958,7 @@

    ContentInvalidBlacklistedContent

    ContentInvalidBlacklistedContent: = 168
    @@ -1943,7 +1968,7 @@

    ContentInvalidExternalUrl

    ContentInvalidExternalUrl: = 139
    @@ -1953,7 +1978,7 @@

    ContentInvalidId

    ContentInvalidId: = 106
    @@ -1963,7 +1988,7 @@

    ContentInvalidLinkToInternalEnvironment

    ContentInvalidLinkToInternalEnvironment: = 167
    @@ -1973,7 +1998,7 @@

    ContentInvalidMigrationFile

    ContentInvalidMigrationFile: = 157
    @@ -1983,7 +2008,7 @@

    ContentInvalidState

    ContentInvalidState: = 115
    @@ -1993,7 +2018,7 @@

    ContentItemNotBasedOnLatestRevision

    ContentItemNotBasedOnLatestRevision: = 162
    @@ -2003,7 +2028,7 @@

    ContentItemPropertyAggregationError

    ContentItemPropertyAggregationError: = 124
    @@ -2013,7 +2038,7 @@

    ContentLocaleDidNotMatchExpected

    ContentLocaleDidNotMatchExpected: = 172
    @@ -2023,7 +2048,7 @@

    ContentLocaleEditPermissionDenied

    ContentLocaleEditPermissionDenied: = 175
    @@ -2033,7 +2058,7 @@

    ContentLocalePermissionDenied

    ContentLocalePermissionDenied: = 166
    @@ -2043,7 +2068,7 @@

    ContentLockedForChanges

    ContentLockedForChanges: = 135
    @@ -2053,7 +2078,7 @@

    ContentMacroMalformedNoContentId

    ContentMacroMalformedNoContentId: = 169
    @@ -2063,7 +2088,7 @@

    ContentMacroMalformedNoTemplateType

    ContentMacroMalformedNoTemplateType: = 170
    @@ -2073,7 +2098,7 @@

    ContentMaxLengthFailOnProperty

    ContentMaxLengthFailOnProperty: = 153
    @@ -2083,7 +2108,7 @@

    ContentMigrationAlteringProcessedItem

    ContentMigrationAlteringProcessedItem: = 158
    @@ -2093,7 +2118,7 @@

    ContentNavigationParentNotFound

    ContentNavigationParentNotFound: = 116
    @@ -2103,7 +2128,7 @@

    ContentNavigationParentUpdateError

    ContentNavigationParentUpdateError: = 117
    @@ -2113,7 +2138,7 @@

    ContentNeedUniquePath

    ContentNeedUniquePath: = 101
    @@ -2123,7 +2148,7 @@

    ContentNotFound

    ContentNotFound: = 103
    @@ -2133,7 +2158,7 @@

    ContentNotReviewed

    ContentNotReviewed: = 137
    @@ -2143,7 +2168,7 @@

    ContentPackagesInconsistent

    ContentPackagesInconsistent: = 131
    @@ -2153,7 +2178,7 @@

    ContentPackagesInconsistentType

    ContentPackagesInconsistentType: = 133
    @@ -2163,7 +2188,7 @@

    ContentPackagesInvalidState

    ContentPackagesInvalidState: = 132
    @@ -2173,7 +2198,7 @@

    ContentPerforceChangelistFileItemsNotFound

    ContentPerforceChangelistFileItemsNotFound: = 144
    @@ -2183,7 +2208,7 @@

    ContentPerforceChangelistResultNotFound

    ContentPerforceChangelistResultNotFound: = 143
    @@ -2193,7 +2218,7 @@

    ContentPerforceFileHistoryNotFound

    ContentPerforceFileHistoryNotFound: = 126
    @@ -2203,7 +2228,7 @@

    ContentPerforceInitializationError

    ContentPerforceInitializationError: = 110
    @@ -2213,7 +2238,7 @@

    ContentPerforceInvalidRevisionError

    ContentPerforceInvalidRevisionError: = 145
    @@ -2223,7 +2248,7 @@

    ContentPerforceSubmissionError

    ContentPerforceSubmissionError: = 109
    @@ -2233,7 +2258,7 @@

    ContentPerforceUnmatchedFileError

    ContentPerforceUnmatchedFileError: = 142
    @@ -2243,7 +2268,7 @@

    ContentPermissionDenied

    ContentPermissionDenied: = 138
    @@ -2253,7 +2278,7 @@

    ContentPhysicalFileCreationError

    ContentPhysicalFileCreationError: = 108
    @@ -2263,7 +2288,7 @@

    ContentPhysicalFileDeletionError

    ContentPhysicalFileDeletionError: = 107
    @@ -2273,7 +2298,7 @@

    ContentProjectNotFound

    ContentProjectNotFound: = 129
    @@ -2283,7 +2308,7 @@

    ContentPropertiesValidationError

    ContentPropertiesValidationError: = 120
    @@ -2293,7 +2318,7 @@

    ContentPropertyCannotDeserialize

    ContentPropertyCannotDeserialize: = 151
    @@ -2303,7 +2328,7 @@

    ContentPropertyDefinitionNotFound

    ContentPropertyDefinitionNotFound: = 159
    @@ -2313,7 +2338,7 @@

    ContentPropertyInvalidDate

    ContentPropertyInvalidDate: = 149
    @@ -2323,7 +2348,7 @@

    ContentPropertyInvalidNumber

    ContentPropertyInvalidNumber: = 147
    @@ -2333,7 +2358,7 @@

    ContentPropertyInvalidSet

    ContentPropertyInvalidSet: = 150
    @@ -2343,7 +2368,7 @@

    ContentPropertyInvalidUrl

    ContentPropertyInvalidUrl: = 148
    @@ -2353,7 +2378,7 @@

    ContentPropertyRequired

    ContentPropertyRequired: = 155
    @@ -2363,7 +2388,7 @@

    ContentPropertyUnexpectedDeserializationError

    ContentPropertyUnexpectedDeserializationError: = 154
    @@ -2373,7 +2398,7 @@

    ContentRegexValidationFailOnProperty

    ContentRegexValidationFailOnProperty: = 152
    @@ -2383,7 +2408,7 @@

    ContentReviewDataChanged

    ContentReviewDataChanged: = 160
    @@ -2393,7 +2418,7 @@

    ContentRollbackRevisionNotInPackage

    ContentRollbackRevisionNotInPackage: = 161
    @@ -2403,7 +2428,7 @@

    ContentSearchInvalidParameters

    ContentSearchInvalidParameters: = 123
    @@ -2413,7 +2438,7 @@

    ContentSearchMissingParameters

    ContentSearchMissingParameters: = 105
    @@ -2423,7 +2448,7 @@

    ContentSqlException

    ContentSqlException: = 102
    @@ -2433,7 +2458,7 @@

    ContentSuccessWithTagAddFail

    ContentSuccessWithTagAddFail: = 104
    @@ -2443,7 +2468,7 @@

    ContentTagSaveFailure

    ContentTagSaveFailure: = 141
    @@ -2453,7 +2478,7 @@

    ContentTooManyResults

    ContentTooManyResults: = 113
    @@ -2463,7 +2488,7 @@

    ContentTypeNotFound

    ContentTypeNotFound: = 121
    @@ -2473,7 +2498,7 @@

    ContentUnauthorized

    ContentUnauthorized: = 163
    @@ -2483,7 +2508,7 @@

    ContentUnknownSqlResult

    ContentUnknownSqlResult: = 100
    @@ -2493,7 +2518,7 @@

    ContentUnloadedSaveResult

    ContentUnloadedSaveResult: = 146
    @@ -2503,7 +2528,7 @@

    ContentUploadFailed

    ContentUploadFailed: = 112
    @@ -2513,7 +2538,7 @@

    ContentUserNotFound

    ContentUserNotFound: = 165
    @@ -2523,7 +2548,7 @@

    ContentValidationError

    ContentValidationError: = 119
    @@ -2533,7 +2558,7 @@

    CookieContextRequired

    CookieContextRequired: = 96
    @@ -2543,7 +2568,7 @@

    DataNotFound

    DataNotFound: = 11
    @@ -2553,7 +2578,7 @@

    DeploymentPackageFileNotFound

    DeploymentPackageFileNotFound: = 125
    @@ -2563,7 +2588,7 @@

    DeploymentPackageNotEditable

    DeploymentPackageNotEditable: = 118
    @@ -2573,7 +2598,7 @@

    DeploymentPackageNotFound

    DeploymentPackageNotFound: = 122
    @@ -2583,7 +2608,7 @@

    DestinyAccountAcquisitionFailure

    DestinyAccountAcquisitionFailure: = 1600
    @@ -2593,7 +2618,7 @@

    DestinyAccountMustBeOffline

    DestinyAccountMustBeOffline: = 1654
    @@ -2603,7 +2628,7 @@

    DestinyAccountNotFound

    DestinyAccountNotFound: = 1601
    @@ -2613,7 +2638,7 @@

    DestinyActionInsufficientPrivileges

    DestinyActionInsufficientPrivileges: = 1666
    @@ -2623,7 +2648,7 @@

    DestinyBucketNotFound

    DestinyBucketNotFound: = 1633
    @@ -2633,7 +2658,7 @@

    DestinyBuildStatsDatabaseError

    DestinyBuildStatsDatabaseError: = 1602
    @@ -2643,7 +2668,7 @@

    DestinyCanOnlyEquipInGame

    DestinyCanOnlyEquipInGame: = 1655
    @@ -2653,7 +2678,7 @@

    DestinyCannotAffordMaterialRequirements

    DestinyCannotAffordMaterialRequirements: = 1675
    @@ -2663,7 +2688,7 @@

    DestinyCannotPerformActionAtThisLocation

    DestinyCannotPerformActionAtThisLocation: = 1671
    @@ -2673,7 +2698,7 @@

    DestinyCannotPerformActionOnEquippedItem

    DestinyCannotPerformActionOnEquippedItem: = 1656
    @@ -2683,7 +2708,7 @@

    DestinyCharacterLoggedInNotAllowed

    DestinyCharacterLoggedInNotAllowed: = 1681
    @@ -2693,7 +2718,7 @@

    DestinyCharacterNotFound

    DestinyCharacterNotFound: = 1620
    @@ -2703,7 +2728,7 @@

    DestinyCharacterNotInTower

    DestinyCharacterNotInTower: = 1634
    @@ -2720,7 +2745,7 @@

    DestinyCharacterNotLoggedIn

    DestinyCharacterNotLoggedIn: = 1635
    @@ -2730,7 +2755,7 @@

    DestinyCharacterStatsDatabaseError

    DestinyCharacterStatsDatabaseError: = 1603
    @@ -2740,7 +2765,7 @@

    DestinyContentConfigNotFound

    DestinyContentConfigNotFound: = 1616
    @@ -2750,7 +2775,7 @@

    DestinyContentItemNotFound

    DestinyContentItemNotFound: = 1613
    @@ -2760,7 +2785,7 @@

    DestinyContentLookupNotFoundForKey

    DestinyContentLookupNotFoundForKey: = 1612
    @@ -2770,7 +2795,7 @@

    DestinyContentPropertyBucketValueNotFound

    DestinyContentPropertyBucketValueNotFound: = 1617
    @@ -2780,7 +2805,7 @@

    DestinyContentPropertyNotFound

    DestinyContentPropertyNotFound: = 1615
    @@ -2790,7 +2815,7 @@

    DestinyContentSectionNotFound

    DestinyContentSectionNotFound: = 1614
    @@ -2800,7 +2825,7 @@

    DestinyContentVersionMismatch

    DestinyContentVersionMismatch: = 1662
    @@ -2810,7 +2835,7 @@

    DestinyDefinitionsNotLoaded

    DestinyDefinitionsNotLoaded: = 1636
    @@ -2820,7 +2845,7 @@

    DestinyErrorDeserializationFailure

    DestinyErrorDeserializationFailure: = 1649
    @@ -2830,7 +2855,7 @@

    DestinyFailedPlugInsertionRules

    DestinyFailedPlugInsertionRules: = 1676
    @@ -2840,7 +2865,7 @@

    DestinyGrimoireStatsDatabaseError

    DestinyGrimoireStatsDatabaseError: = 1606
    @@ -2850,7 +2875,7 @@

    DestinyInternalError

    DestinyInternalError: = 1626
    @@ -2860,7 +2885,7 @@

    DestinyInvalidAction

    DestinyInvalidAction: = 1619
    @@ -2870,7 +2895,7 @@

    DestinyInvalidClaimException

    DestinyInvalidClaimException: = 1667
    @@ -2880,7 +2905,7 @@

    DestinyInvalidCustomizationChoices

    DestinyInvalidCustomizationChoices: = 1624
    @@ -2890,7 +2915,7 @@

    DestinyInvalidFlag

    DestinyInvalidFlag: = 1621
    @@ -2900,7 +2925,7 @@

    DestinyInvalidMembershipType

    DestinyInvalidMembershipType: = 1630
    @@ -2910,7 +2935,7 @@

    DestinyInvalidRequest

    DestinyInvalidRequest: = 1622
    @@ -2920,7 +2945,7 @@

    DestinyInventoryFull

    DestinyInventoryFull: = 1637
    @@ -2930,7 +2955,7 @@

    DestinyItemActionForbidden

    DestinyItemActionForbidden: = 1663
    @@ -2940,7 +2965,7 @@

    DestinyItemAlreadyInInventory

    DestinyItemAlreadyInInventory: = 1632
    @@ -2950,7 +2975,7 @@

    DestinyItemBucketNotFound

    DestinyItemBucketNotFound: = 1629
    @@ -2960,7 +2985,7 @@

    DestinyItemFailedLevelCheck

    DestinyItemFailedLevelCheck: = 1638
    @@ -2970,7 +2995,7 @@

    DestinyItemFailedUnlockCheck

    DestinyItemFailedUnlockCheck: = 1639
    @@ -2980,7 +3005,7 @@

    DestinyItemLocked

    DestinyItemLocked: = 1674
    @@ -2990,7 +3015,7 @@

    DestinyItemNotFound

    DestinyItemNotFound: = 1623
    @@ -3000,7 +3025,7 @@

    DestinyItemNotTransferrable

    DestinyItemNotTransferrable: = 1660
    @@ -3010,7 +3035,7 @@

    DestinyItemNotTransferrableHasSideEffects

    DestinyItemNotTransferrableHasSideEffects: = 1673
    @@ -3020,7 +3045,7 @@

    DestinyItemUnequippable

    DestinyItemUnequippable: = 1640
    @@ -3030,7 +3055,7 @@

    DestinyItemUniqueEquipRestricted

    DestinyItemUniqueEquipRestricted: = 1641
    @@ -3040,7 +3065,7 @@

    DestinyLegacyPlatformInUse

    DestinyLegacyPlatformInUse: = 1669
    @@ -3050,7 +3075,7 @@

    DestinyLegacyPlatformInaccessible

    DestinyLegacyPlatformInaccessible: = 1670
    @@ -3060,7 +3085,7 @@

    DestinyLegacyPlatformRestricted

    DestinyLegacyPlatformRestricted: = 1668
    @@ -3070,7 +3095,7 @@

    DestinyNoRoomInDestination

    DestinyNoRoomInDestination: = 1642
    @@ -3080,7 +3105,7 @@

    DestinyPGCRNotFound

    DestinyPGCRNotFound: = 1653
    @@ -3090,7 +3115,7 @@

    DestinyPlugItemNotAvailable

    DestinyPlugItemNotAvailable: = 1680
    @@ -3100,7 +3125,7 @@

    DestinyPrivacyRestriction

    DestinyPrivacyRestriction: = 1665
    @@ -3110,7 +3135,7 @@

    DestinyPublicAccountNotAccessible

    DestinyPublicAccountNotAccessible: = 1682
    @@ -3120,7 +3145,7 @@

    DestinyPvEStatsDatabaseError

    DestinyPvEStatsDatabaseError: = 1605
    @@ -3130,7 +3155,7 @@

    DestinyPvPStatsDatabaseError

    DestinyPvPStatsDatabaseError: = 1604
    @@ -3140,7 +3165,7 @@

    DestinyQuestAlreadyCompleted

    DestinyQuestAlreadyCompleted: = 1657
    @@ -3150,7 +3175,7 @@

    DestinyQuestAlreadyTracked

    DestinyQuestAlreadyTracked: = 1658
    @@ -3160,7 +3185,7 @@

    DestinyRecentActivitiesDatabaseError

    DestinyRecentActivitiesDatabaseError: = 1628
    @@ -3170,7 +3195,7 @@

    DestinyRefundInvalid

    DestinyRefundInvalid: = 1664
    @@ -3180,7 +3205,7 @@

    DestinyServiceFailure

    DestinyServiceFailure: = 1643
    @@ -3190,7 +3215,7 @@

    DestinyServiceRetired

    DestinyServiceRetired: = 1644
    @@ -3200,7 +3225,7 @@

    DestinyShardRelayClientTimeout

    DestinyShardRelayClientTimeout: = 1651
    @@ -3210,7 +3235,7 @@

    DestinyShardRelayProxyTimeout

    DestinyShardRelayProxyTimeout: = 1652
    @@ -3220,7 +3245,7 @@

    DestinySocketActionNotAllowed

    DestinySocketActionNotAllowed: = 1678
    @@ -3230,7 +3255,7 @@

    DestinySocketAlreadyHasPlug

    DestinySocketAlreadyHasPlug: = 1679
    @@ -3240,7 +3265,7 @@

    DestinySocketNotFound

    DestinySocketNotFound: = 1677
    @@ -3250,7 +3275,7 @@

    DestinyStatsParameterMembershipIdParseError

    DestinyStatsParameterMembershipIdParseError: = 1608
    @@ -3260,7 +3285,7 @@

    DestinyStatsParameterMembershipTypeParseError<
    DestinyStatsParameterMembershipTypeParseError: = 1607
    @@ -3270,7 +3295,7 @@

    DestinyStatsParameterRangeParseError

    DestinyStatsParameterRangeParseError: = 1609
    @@ -3280,7 +3305,7 @@

    DestinyStringItemHashNotFound

    DestinyStringItemHashNotFound: = 1610
    @@ -3290,7 +3315,7 @@

    DestinyStringSetNotFound

    DestinyStringSetNotFound: = 1611
    @@ -3300,7 +3325,7 @@

    DestinyThrottledByGameServer

    DestinyThrottledByGameServer: = 1672
    @@ -3310,7 +3335,7 @@

    DestinyTrackableQuestsFull

    DestinyTrackableQuestsFull: = 1659
    @@ -3320,7 +3345,7 @@

    DestinyTransferFailed

    DestinyTransferFailed: = 1645
    @@ -3330,7 +3355,7 @@

    DestinyTransferNotFoundForSourceBucket

    DestinyTransferNotFoundForSourceBucket: = 1646
    @@ -3340,7 +3365,7 @@

    DestinyUnexpectedError

    DestinyUnexpectedError: = 1618
    @@ -3350,7 +3375,7 @@

    DestinyUnexpectedResultInVendorTransferCheck

    DestinyUnexpectedResultInVendorTransferCheck: = 1647
    @@ -3360,7 +3385,7 @@

    DestinyUniquenessViolation

    DestinyUniquenessViolation: = 1648
    @@ -3370,7 +3395,7 @@

    DestinyValidAccountTicketRequired

    DestinyValidAccountTicketRequired: = 1650
    @@ -3380,7 +3405,7 @@

    DestinyVendorItemNotFound

    DestinyVendorItemNotFound: = 1625
    @@ -3390,7 +3415,7 @@

    DestinyVendorNotFound

    DestinyVendorNotFound: = 1627
    @@ -3400,7 +3425,7 @@

    DestinyVendorPurchaseNotAllowed

    DestinyVendorPurchaseNotAllowed: = 1661
    @@ -3410,7 +3435,7 @@

    DestinyVersionIncompatibility

    DestinyVersionIncompatibility: = 1631
    @@ -3420,7 +3445,7 @@

    DiscountAlreadyClaimed

    DiscountAlreadyClaimed: = 2039
    @@ -3430,7 +3455,7 @@

    DiscountAlreadyExists

    DiscountAlreadyExists: = 2043
    @@ -3440,7 +3465,7 @@

    DiscountClaimFailure

    DiscountClaimFailure: = 2040
    @@ -3450,7 +3475,7 @@

    DiscountConfigurationFailure

    DiscountConfigurationFailure: = 2041
    @@ -3460,7 +3485,7 @@

    DiscountGenerationFailure

    DiscountGenerationFailure: = 2042
    @@ -3470,7 +3495,7 @@

    Duplicate

    Duplicate: = 13
    @@ -3480,7 +3505,7 @@

    ExPlatformStringValidationError

    ExPlatformStringValidationError: = 53
    @@ -3490,7 +3515,7 @@

    ExternalServiceFailed

    ExternalServiceFailed: = 42
    @@ -3500,7 +3525,7 @@

    ExternalServiceTimeout

    ExternalServiceTimeout: = 27
    @@ -3510,7 +3535,7 @@

    ExternalServiceUnknown

    ExternalServiceUnknown: = 38
    @@ -3520,7 +3545,7 @@

    FacebookTokenExpired

    FacebookTokenExpired: = 94
    @@ -3530,7 +3555,7 @@

    FailedToLoadAvailableLocalesConfiguration

    FailedToLoadAvailableLocalesConfiguration: = 6
    @@ -3540,7 +3565,7 @@

    FbAccessDenied

    FbAccessDenied: = 1802
    @@ -3550,7 +3575,7 @@

    FbInvalidGrant

    FbInvalidGrant: = 1806
    @@ -3560,7 +3585,7 @@

    FbInvalidRequest

    FbInvalidRequest: = 1800
    @@ -3570,7 +3595,7 @@

    FbInvalidScope

    FbInvalidScope: = 1804
    @@ -3580,7 +3605,7 @@

    FbRedirectMismatch

    FbRedirectMismatch: = 1801
    @@ -3590,7 +3615,7 @@

    FbUnsupportedGrantType

    FbUnsupportedGrantType: = 1805
    @@ -3600,7 +3625,7 @@

    FbUnsupportedResponseType

    FbUnsupportedResponseType: = 1803
    @@ -3610,7 +3635,7 @@

    FollowUnsupportedEntityType

    FollowUnsupportedEntityType: = 807
    @@ -3620,7 +3645,7 @@

    ForumAgeLock

    ForumAgeLock: = 578
    @@ -3630,7 +3655,7 @@

    ForumAliasedTagError

    ForumAliasedTagError: = 511
    @@ -3640,7 +3665,7 @@

    ForumAnnouncementNotAllowed

    ForumAnnouncementNotAllowed: = 538
    @@ -3650,7 +3675,7 @@

    ForumAnswerCannotBeMadeOnCreatePost

    ForumAnswerCannotBeMadeOnCreatePost: = 565
    @@ -3660,7 +3685,7 @@

    ForumAnswerCannotBeMadeOnEditPost

    ForumAnswerCannotBeMadeOnEditPost: = 566
    @@ -3670,7 +3695,7 @@

    ForumAnswerPostIdIsNotADirectReplyOfQuestionForumAnswerPostIdIsNotADirectReplyOfQuestion: = 567

    @@ -3680,7 +3705,7 @@

    ForumAnswerTopicIdIsNotAQuestion

    ForumAnswerTopicIdIsNotAQuestion: = 568
    @@ -3690,7 +3715,7 @@

    ForumAuthorAccessError

    ForumAuthorAccessError: = 524
    @@ -3700,7 +3725,7 @@

    ForumBannedPostsCannotBeEdited

    ForumBannedPostsCannotBeEdited: = 562
    @@ -3710,7 +3735,7 @@

    ForumBodyCannotBeEmpty

    ForumBodyCannotBeEmpty: = 500
    @@ -3720,7 +3745,7 @@

    ForumBodyTooLong

    ForumBodyTooLong: = 536
    @@ -3730,7 +3755,7 @@

    ForumCanOnlyDeleteTopics

    ForumCanOnlyDeleteTopics: = 557
    @@ -3740,7 +3765,7 @@

    ForumCanOnlyRateTopics

    ForumCanOnlyRateTopics: = 561
    @@ -3750,7 +3775,7 @@

    ForumCannotApplyForumIdToNonTopics

    ForumCannotApplyForumIdToNonTopics: = 582
    @@ -3760,7 +3785,7 @@

    ForumCannotApplyForumIdWithoutTags

    ForumCannotApplyForumIdWithoutTags: = 581
    @@ -3770,7 +3795,7 @@

    ForumCannotCreateContentTopic

    ForumCannotCreateContentTopic: = 530
    @@ -3780,7 +3805,7 @@

    ForumCannotCrossPostBetweenGroups

    ForumCannotCrossPostBetweenGroups: = 544
    @@ -3790,7 +3815,7 @@

    ForumCannotDownvoteCommunityCreations

    ForumCannotDownvoteCommunityCreations: = 583
    @@ -3800,7 +3825,7 @@

    ForumCannotEditModeratorEditedPost

    ForumCannotEditModeratorEditedPost: = 575
    @@ -3810,7 +3835,7 @@

    ForumCannotGetRating

    ForumCannotGetRating: = 518
    @@ -3820,7 +3845,7 @@

    ForumCannotLocateParentPost

    ForumCannotLocateParentPost: = 502
    @@ -3830,7 +3855,7 @@

    ForumCannotLocatePost

    ForumCannotLocatePost: = 514
    @@ -3840,7 +3865,7 @@

    ForumCannotLocateThread

    ForumCannotLocateThread: = 512
    @@ -3850,7 +3875,7 @@

    ForumCannotRateYourOwnPosts

    ForumCannotRateYourOwnPosts: = 571
    @@ -3860,7 +3885,7 @@

    ForumCannotShareOwnPost

    ForumCannotShareOwnPost: = 539
    @@ -3870,7 +3895,7 @@

    ForumCannotSharePrivatePost

    ForumCannotSharePrivatePost: = 543
    @@ -3880,7 +3905,7 @@

    ForumCannotUseOfficialTagCategoryAsTag

    ForumCannotUseOfficialTagCategoryAsTag: = 564
    @@ -3890,7 +3915,7 @@

    ForumCannotUseTheseCategoriesOnNonTopicPo
    ForumCannotUseTheseCategoriesOnNonTopicPost: = 556
    @@ -3900,7 +3925,7 @@

    ForumContentCommentsNotAllowed

    ForumContentCommentsNotAllowed: = 532
    @@ -3910,7 +3935,7 @@

    ForumDeleteSqlException

    ForumDeleteSqlException: = 558
    @@ -3920,7 +3945,7 @@

    ForumDeleteSqlUnknownResult

    ForumDeleteSqlUnknownResult: = 559
    @@ -3930,7 +3955,7 @@

    ForumEditNoOp

    ForumEditNoOp: = 540
    @@ -3940,7 +3965,7 @@

    ForumEditPermissionDenied

    ForumEditPermissionDenied: = 516
    @@ -3950,7 +3975,7 @@

    ForumExceeedMaximumRowLimit

    ForumExceeedMaximumRowLimit: = 542
    @@ -3960,7 +3985,7 @@

    ForumExceptionDuringTagSearch

    ForumExceptionDuringTagSearch: = 509
    @@ -3970,7 +3995,7 @@

    ForumExceptionDuringTopicRetrieval

    ForumExceptionDuringTopicRetrieval: = 510
    @@ -3980,7 +4005,7 @@

    ForumGroupAccessError

    ForumGroupAccessError: = 525
    @@ -3990,7 +4015,7 @@

    ForumGroupAdminEditNonMember

    ForumGroupAdminEditNonMember: = 574
    @@ -4000,7 +4025,7 @@

    ForumIncompatibleCategories

    ForumIncompatibleCategories: = 555
    @@ -4010,7 +4035,7 @@

    ForumInvalidPollInput

    ForumInvalidPollInput: = 573
    @@ -4020,7 +4045,7 @@

    ForumLatestReplyAccessError

    ForumLatestReplyAccessError: = 522
    @@ -4030,7 +4055,7 @@

    ForumMaxPages

    ForumMaxPages: = 579
    @@ -4040,7 +4065,7 @@

    ForumMaxPagesOldestFirst

    ForumMaxPagesOldestFirst: = 580
    @@ -4050,7 +4075,7 @@

    ForumPollsMustBeTheFirstPostInTopic

    ForumPollsMustBeTheFirstPostInTopic: = 572
    @@ -4060,7 +4085,7 @@

    ForumPostValidationBadUrl

    ForumPostValidationBadUrl: = 535
    @@ -4070,7 +4095,7 @@

    ForumQuestionMustBeTopicPost

    ForumQuestionMustBeTopicPost: = 508
    @@ -4080,7 +4105,7 @@

    ForumRatingsAccessError

    ForumRatingsAccessError: = 520
    @@ -4090,7 +4115,7 @@

    ForumRecruitmentApproveFailMessageBan

    ForumRecruitmentApproveFailMessageBan: = 591
    @@ -4100,7 +4125,7 @@

    ForumRecruitmentFireteamMembersOnly

    ForumRecruitmentFireteamMembersOnly: = 594
    @@ -4110,7 +4135,7 @@

    ForumRecruitmentGlobalBan

    ForumRecruitmentGlobalBan: = 592
    @@ -4120,7 +4145,7 @@

    ForumRecruitmentTopicKickBan

    ForumRecruitmentTopicKickBan: = 588
    @@ -4130,7 +4155,7 @@

    ForumRecruitmentTopicMalformed

    ForumRecruitmentTopicMalformed: = 585
    @@ -4140,7 +4165,7 @@

    ForumRecruitmentTopicNoPlayers

    ForumRecruitmentTopicNoPlayers: = 590
    @@ -4150,7 +4175,7 @@

    ForumRecruitmentTopicNoSlotsRemaining

    ForumRecruitmentTopicNoSlotsRemaining: = 587
    @@ -4160,7 +4185,7 @@

    ForumRecruitmentTopicNotFound

    ForumRecruitmentTopicNotFound: = 586
    @@ -4170,7 +4195,7 @@

    ForumRecruitmentTopicRequirementsNotMet

    ForumRecruitmentTopicRequirementsNotMet: = 589
    @@ -4180,7 +4205,7 @@

    ForumRelatedPostAccessError

    ForumRelatedPostAccessError: = 521
    @@ -4190,7 +4215,7 @@

    ForumRepliesCannotBeEmpty

    ForumRepliesCannotBeEmpty: = 527
    @@ -4200,7 +4225,7 @@

    ForumRepliesCannotBeInDifferentGroups

    ForumRepliesCannotBeInDifferentGroups: = 528
    @@ -4210,7 +4235,7 @@

    ForumRequiresDestiny2Progress

    ForumRequiresDestiny2Progress: = 595
    @@ -4220,7 +4245,7 @@

    ForumRequiresDestinyMembership

    ForumRequiresDestinyMembership: = 576
    @@ -4230,7 +4255,7 @@

    ForumSubTopicCannotBeCreatedAtThisThreadL
    ForumSubTopicCannotBeCreatedAtThisThreadLevel: = 529
    @@ -4240,7 +4265,7 @@

    ForumSubjectCannotBeEmptyOnTopicPost

    ForumSubjectCannotBeEmptyOnTopicPost: = 501
    @@ -4250,7 +4275,7 @@

    ForumSubjectTooLong

    ForumSubjectTooLong: = 537
    @@ -4260,7 +4285,7 @@

    ForumThreadLockedForReplies

    ForumThreadLockedForReplies: = 503
    @@ -4270,7 +4295,7 @@

    ForumThreadRootIsBanned

    ForumThreadRootIsBanned: = 563
    @@ -4280,7 +4305,7 @@

    ForumTooManyTags

    ForumTooManyTags: = 560
    @@ -4290,7 +4315,7 @@

    ForumTopicDoesNotExist

    ForumTopicDoesNotExist: = 531
    @@ -4300,7 +4325,7 @@

    ForumTopicsMustHaveOfficialCategory

    ForumTopicsMustHaveOfficialCategory: = 584
    @@ -4310,7 +4335,7 @@

    ForumUnexpectedError

    ForumUnexpectedError: = 577
    @@ -4320,7 +4345,7 @@

    ForumUnknownDatabaseErrorDuringGetPost

    ForumUnknownDatabaseErrorDuringGetPost: = 541
    @@ -4330,7 +4355,7 @@

    ForumUnknownExceptionCreatePost

    ForumUnknownExceptionCreatePost: = 507
    @@ -4340,7 +4365,7 @@

    ForumUnknownExceptionDuringMarkAnswer

    ForumUnknownExceptionDuringMarkAnswer: = 569
    @@ -4350,7 +4375,7 @@

    ForumUnknownExceptionEditPost

    ForumUnknownExceptionEditPost: = 513
    @@ -4360,7 +4385,7 @@

    ForumUnknownExceptionGetOrCreateTags

    ForumUnknownExceptionGetOrCreateTags: = 515
    @@ -4370,7 +4395,7 @@

    ForumUnknownExceptionGetRating

    ForumUnknownExceptionGetRating: = 519
    @@ -4380,7 +4405,7 @@

    ForumUnknownSqlResultDuringCreatePost

    ForumUnknownSqlResultDuringCreatePost: = 504
    @@ -4390,7 +4415,7 @@

    ForumUnknownSqlResultDuringEditPost

    ForumUnknownSqlResultDuringEditPost: = 533
    @@ -4400,7 +4425,7 @@

    ForumUnknownSqlResultDuringGetPost

    ForumUnknownSqlResultDuringGetPost: = 534
    @@ -4410,7 +4435,7 @@

    ForumUnknownSqlResultDuringMarkAnswer

    ForumUnknownSqlResultDuringMarkAnswer: = 570
    @@ -4420,7 +4445,7 @@

    ForumUnknownSqlResultDuringTagIdRetrieval

    ForumUnknownSqlResultDuringTagIdRetrieval: = 517
    @@ -4430,7 +4455,7 @@

    ForumUnknownSqlResultDuringTagItem

    ForumUnknownSqlResultDuringTagItem: = 506
    @@ -4440,7 +4465,7 @@

    ForumUnknownTagCreationError

    ForumUnknownTagCreationError: = 505
    @@ -4450,7 +4475,7 @@

    ForumUrlExpectedButMissing

    ForumUrlExpectedButMissing: = 526
    @@ -4460,7 +4485,7 @@

    ForumUserBannedFromThisTopic

    ForumUserBannedFromThisTopic: = 593
    @@ -4470,7 +4495,7 @@

    ForumUserStatusAccessError

    ForumUserStatusAccessError: = 523
    @@ -4480,7 +4505,7 @@

    GroupAdminAccessError

    GroupAdminAccessError: = 616
    @@ -4490,7 +4515,7 @@

    GroupAlreadyAllied

    GroupAlreadyAllied: = 641
    @@ -4500,7 +4525,7 @@

    GroupAlreadyMember

    GroupAlreadyMember: = 642
    @@ -4510,7 +4535,7 @@

    GroupAtMaximumAlliances

    GroupAtMaximumAlliances: = 646
    @@ -4520,7 +4545,7 @@

    GroupCannotCheckBanStatus

    GroupCannotCheckBanStatus: = 628
    @@ -4530,7 +4555,7 @@

    GroupCannotSetClanOnlySettings

    GroupCannotSetClanOnlySettings: = 647
    @@ -4540,7 +4565,7 @@

    GroupCreatorAccessError

    GroupCreatorAccessError: = 615
    @@ -4550,7 +4575,7 @@

    GroupCultureThrottle

    GroupCultureThrottle: = 694
    @@ -4560,7 +4585,7 @@

    GroupDeleted

    GroupDeleted: = 621
    @@ -4570,7 +4595,7 @@

    GroupDeletionGracePeriodExpired

    GroupDeletionGracePeriodExpired: = 627
    @@ -4580,7 +4605,7 @@

    GroupFollowLimitExceeded

    GroupFollowLimitExceeded: = 804
    @@ -4590,7 +4615,7 @@

    GroupIdNotReturnedFromCreation

    GroupIdNotReturnedFromCreation: = 604
    @@ -4600,7 +4625,7 @@

    GroupInvalidId

    GroupInvalidId: = 607
    @@ -4610,7 +4635,7 @@

    GroupInvalidMembershipId

    GroupInvalidMembershipId: = 608
    @@ -4620,7 +4645,7 @@

    GroupInvalidMembershipType

    GroupInvalidMembershipType: = 609
    @@ -4630,7 +4655,7 @@

    GroupInvalidPlatformType

    GroupInvalidPlatformType: = 650
    @@ -4640,7 +4665,7 @@

    GroupInvalidRating

    GroupInvalidRating: = 612
    @@ -4650,7 +4675,7 @@

    GroupInvalidResolveState

    GroupInvalidResolveState: = 652
    @@ -4660,7 +4685,7 @@

    GroupInviteAlreadyMember

    GroupInviteAlreadyMember: = 677
    @@ -4670,7 +4695,7 @@

    GroupJoinApprovalRequired

    GroupJoinApprovalRequired: = 678
    @@ -4680,7 +4705,7 @@

    GroupJoinedCannotSetClanName

    GroupJoinedCannotSetClanName: = 633
    @@ -4690,7 +4715,7 @@

    GroupLeftCannotClearClanName

    GroupLeftCannotClearClanName: = 634
    @@ -4700,7 +4725,7 @@

    GroupMaximumMembershipCountReached

    GroupMaximumMembershipCountReached: = 629
    @@ -4710,7 +4735,7 @@

    GroupMemberBanned

    GroupMemberBanned: = 623
    @@ -4720,7 +4745,7 @@

    GroupMemberInvalidMemberType

    GroupMemberInvalidMemberType: = 649
    @@ -4730,7 +4755,7 @@

    GroupMemberInvalidSort

    GroupMemberInvalidSort: = 651
    @@ -4740,7 +4765,7 @@

    GroupMembershipAlreadyApplied

    GroupMembershipAlreadyApplied: = 602
    @@ -4750,7 +4775,7 @@

    GroupMembershipApplicationAlreadyResolved

    GroupMembershipApplicationAlreadyResolved: = 601
    @@ -4760,7 +4785,7 @@

    GroupMembershipClosed

    GroupMembershipClosed: = 624
    @@ -4770,7 +4795,7 @@

    GroupMembershipInsufficientPrivileges

    GroupMembershipInsufficientPrivileges: = 603
    @@ -4780,7 +4805,7 @@

    GroupMembershipNotFound

    GroupMembershipNotFound: = 611
    @@ -4790,7 +4815,7 @@

    GroupMembershipNotLoggedIn

    GroupMembershipNotLoggedIn: = 618
    @@ -4800,7 +4825,7 @@

    GroupMembershipPendingApplicationNotFound

    GroupMembershipPendingApplicationNotFound: = 606
    @@ -4810,7 +4835,7 @@

    GroupMissingTags

    GroupMissingTags: = 610
    @@ -4820,7 +4845,7 @@

    GroupModerationNotPermittedOnNonMembers

    GroupModerationNotPermittedOnNonMembers: = 684
    @@ -4830,7 +4855,7 @@

    GroupNameCannotStartOrEndWithWhiteSpaceGroupNameCannotStartOrEndWithWhiteSpace: = 680

    @@ -4840,7 +4865,7 @@

    GroupNameTaken

    GroupNameTaken: = 626
    @@ -4850,7 +4875,7 @@

    GroupNotDeleted

    GroupNotDeleted: = 619
    @@ -4860,7 +4885,7 @@

    GroupNotFound

    GroupNotFound: = 622
    @@ -4870,7 +4895,7 @@

    GroupNotInAlliance

    GroupNotInAlliance: = 663
    @@ -4880,7 +4905,7 @@

    GroupPrivatePostNotViewable

    GroupPrivatePostNotViewable: = 617
    @@ -4890,7 +4915,7 @@

    GroupPrivatePostOverrideError

    GroupPrivatePostOverrideError: = 625
    @@ -4900,7 +4925,7 @@

    GroupRelationshipAlreadyExists

    GroupRelationshipAlreadyExists: = 643
    @@ -4910,7 +4935,7 @@

    GroupRelationshipBlockNotFound

    GroupRelationshipBlockNotFound: = 638
    @@ -4920,7 +4945,7 @@

    GroupRelationshipNotFound

    GroupRelationshipNotFound: = 639
    @@ -4930,7 +4955,7 @@

    GroupRelationshipRequestBlocked

    GroupRelationshipRequestBlocked: = 636
    @@ -4940,7 +4965,7 @@

    GroupRelationshipRequestNotFound

    GroupRelationshipRequestNotFound: = 637
    @@ -4950,7 +4975,7 @@

    GroupRelationshipRequestPending

    GroupRelationshipRequestPending: = 635
    @@ -4960,7 +4985,7 @@

    GroupSearchInvalidParameters

    GroupSearchInvalidParameters: = 605
    @@ -4970,7 +4995,7 @@

    GroupToGroupAlreadyFollowed

    GroupToGroupAlreadyFollowed: = 665
    @@ -4980,7 +5005,7 @@

    GroupToGroupFollowLimitReached

    GroupToGroupFollowLimitReached: = 659
    @@ -4990,7 +5015,7 @@

    GroupToGroupNotFollowing

    GroupToGroupNotFollowing: = 666
    @@ -5000,7 +5025,7 @@

    GroupUnknownErrorUndeletingGroup

    GroupUnknownErrorUndeletingGroup: = 620
    @@ -5010,7 +5035,7 @@

    GroupUserFollowingAccessError

    GroupUserFollowingAccessError: = 613
    @@ -5020,7 +5045,7 @@

    GroupUserMembershipAccessError

    GroupUserMembershipAccessError: = 614
    @@ -5030,7 +5055,7 @@

    IgnoreCannotIgnoreSelf

    IgnoreCannotIgnoreSelf: = 1005
    @@ -5040,7 +5065,7 @@

    IgnoreErrorInsufficientPermission

    IgnoreErrorInsufficientPermission: = 1003
    @@ -5050,7 +5075,7 @@

    IgnoreErrorRetrievingGroupPermissions

    IgnoreErrorRetrievingGroupPermissions: = 1002
    @@ -5060,7 +5085,7 @@

    IgnoreErrorRetrievingItem

    IgnoreErrorRetrievingItem: = 1004
    @@ -5070,7 +5095,7 @@

    IgnoreIllegalType

    IgnoreIllegalType: = 1006
    @@ -5080,7 +5105,7 @@

    IgnoreInvalidParameters

    IgnoreInvalidParameters: = 1000
    @@ -5090,7 +5115,7 @@

    IgnoreNotFound

    IgnoreNotFound: = 1007
    @@ -5100,7 +5125,7 @@

    IgnoreSqlException

    IgnoreSqlException: = 1001
    @@ -5110,7 +5135,7 @@

    IgnoreUserGloballyIgnored

    IgnoreUserGloballyIgnored: = 1008
    @@ -5120,7 +5145,7 @@

    IgnoreUserIgnored

    IgnoreUserIgnored: = 1009
    @@ -5130,7 +5155,7 @@

    InsufficientPrivileges

    InsufficientPrivileges: = 12
    @@ -5140,7 +5165,7 @@

    InvalidGroupTypesForRelationshipRequest

    InvalidGroupTypesForRelationshipRequest: = 644
    @@ -5150,7 +5175,7 @@

    InvalidPageNumber

    InvalidPageNumber: = 46
    @@ -5160,7 +5185,7 @@

    InvalidParameters

    InvalidParameters: = 18
    @@ -5170,7 +5195,7 @@

    InvalidPostBody

    InvalidPostBody: = 25
    @@ -5180,7 +5205,7 @@

    InvalidReturnValue

    InvalidReturnValue: = 23
    @@ -5190,7 +5215,7 @@

    InvitationAlreadyPending

    InvitationAlreadyPending: = 1904
    @@ -5200,7 +5225,7 @@

    InvitationCannotBeReactivated

    InvitationCannotBeReactivated: = 1908
    @@ -5210,7 +5235,7 @@

    InvitationExpired

    InvitationExpired: = 1900
    @@ -5220,7 +5245,7 @@

    InvitationGroupCannotSendToSelf

    InvitationGroupCannotSendToSelf: = 1911
    @@ -5230,7 +5255,7 @@

    InvitationInsufficientPermission

    InvitationInsufficientPermission: = 1905
    @@ -5240,7 +5265,7 @@

    InvitationInvalid

    InvitationInvalid: = 1913
    @@ -5250,7 +5275,7 @@

    InvitationInvalidCode

    InvitationInvalidCode: = 1906
    @@ -5260,7 +5285,7 @@

    InvitationInvalidResponseStatus

    InvitationInvalidResponseStatus: = 1902
    @@ -5270,7 +5295,7 @@

    InvitationInvalidTargetState

    InvitationInvalidTargetState: = 1907
    @@ -5280,7 +5305,7 @@

    InvitationInvalidType

    InvitationInvalidType: = 1903
    @@ -5290,7 +5315,7 @@

    InvitationNoRecipients

    InvitationNoRecipients: = 1910
    @@ -5300,7 +5325,7 @@

    InvitationNotFound

    InvitationNotFound: = 1914
    @@ -5310,7 +5335,7 @@

    InvitationTooManyRecipients

    InvitationTooManyRecipients: = 1912
    @@ -5320,7 +5345,7 @@

    InvitationUnknownType

    InvitationUnknownType: = 1901
    @@ -5330,7 +5355,7 @@

    ItemAlreadyFollowed

    ItemAlreadyFollowed: = 801
    @@ -5340,7 +5365,7 @@

    ItemNotFollowed

    ItemNotFollowed: = 802
    @@ -5350,7 +5375,7 @@

    JsonDeserializationError

    JsonDeserializationError: = 30
    @@ -5360,7 +5385,7 @@

    LegacyGameStatsMalformedSneakerNetCode

    LegacyGameStatsMalformedSneakerNetCode: = 1502
    @@ -5370,7 +5395,7 @@

    LegacyGameStatsSystemDisabled

    LegacyGameStatsSystemDisabled: = 1500
    @@ -5380,7 +5405,7 @@

    LegacyGameStatsUnknownError

    LegacyGameStatsUnknownError: = 1501
    @@ -5390,7 +5415,7 @@

    MaximumPageSizeExceeded

    MaximumPageSizeExceeded: = 47
    @@ -5400,7 +5425,7 @@

    MessagingCanNotLeaveConversation

    MessagingCanNotLeaveConversation: = 305
    @@ -5410,7 +5435,7 @@

    MessagingCannotDeleteExternalConversation

    MessagingCannotDeleteExternalConversation: = 308
    @@ -5420,7 +5445,7 @@

    MessagingDeletedUserForbidden

    MessagingDeletedUserForbidden: = 307
    @@ -5430,7 +5455,7 @@

    MessagingGroupChatDisabled

    MessagingGroupChatDisabled: = 309
    @@ -5440,7 +5465,7 @@

    MessagingGroupOptionalChatExceededMaximum

    MessagingGroupOptionalChatExceededMaximum: = 312
    @@ -5450,7 +5475,7 @@

    MessagingMustIncludeSelfInPrivateMessage

    MessagingMustIncludeSelfInPrivateMessage: = 310
    @@ -5460,7 +5485,7 @@

    MessagingNoBody

    MessagingNoBody: = 303
    @@ -5470,7 +5495,7 @@

    MessagingSelfError

    MessagingSelfError: = 301
    @@ -5480,7 +5505,7 @@

    MessagingSendThrottle

    MessagingSendThrottle: = 302
    @@ -5490,7 +5515,7 @@

    MessagingSenderIsBanned

    MessagingSenderIsBanned: = 311
    @@ -5500,7 +5525,7 @@

    MessagingTooManyUsers

    MessagingTooManyUsers: = 304
    @@ -5510,7 +5535,7 @@

    MessagingUnableToSend

    MessagingUnableToSend: = 306
    @@ -5520,7 +5545,7 @@

    MessagingUnknownError

    MessagingUnknownError: = 300
    @@ -5530,7 +5555,7 @@

    MissingDeviceCookie

    MissingDeviceCookie: = 93
    @@ -5540,7 +5565,7 @@

    MissingEververseHistoryError

    MissingEververseHistoryError: = 2048
    @@ -5550,7 +5575,7 @@

    MissingOfferConfig

    MissingOfferConfig: = 2051
    @@ -5560,7 +5585,7 @@

    MissingPostBody

    MissingPostBody: = 26
    @@ -5570,7 +5595,7 @@

    NoAvailableDiscountCode

    NoAvailableDiscountCode: = 2038
    @@ -5580,7 +5605,7 @@

    NoClanMembershipForPlatform

    NoClanMembershipForPlatform: = 658
    @@ -5590,7 +5615,7 @@

    NoDestinyAccountForClanPlatform

    NoDestinyAccountForClanPlatform: = 630
    @@ -5600,7 +5625,7 @@

    NoValidTagsInList

    NoValidTagsInList: = 900
    @@ -5610,7 +5635,7 @@

    None

    None: = 0
    @@ -5620,7 +5645,7 @@

    NotAValidPartialTag

    NotAValidPartialTag: = 903
    @@ -5630,7 +5655,7 @@

    NotFound

    NotFound: = 21
    @@ -5640,7 +5665,7 @@

    NotImplemented

    NotImplemented: = 4
    @@ -5650,7 +5675,7 @@

    NotificationSettingInvalid

    NotificationSettingInvalid: = 1100
    @@ -5660,7 +5685,7 @@

    OAuthAccessTokenExpired

    OAuthAccessTokenExpired: = 2115
    @@ -5670,7 +5695,7 @@

    ObsoleteCredentialType

    ObsoleteCredentialType: = 89
    @@ -5680,7 +5705,7 @@

    OfferRequired

    OfferRequired: = 2046
    @@ -5690,7 +5715,7 @@

    OriginHeaderDoesNotMatchKey

    OriginHeaderDoesNotMatchKey: = 2107
    @@ -5700,7 +5725,7 @@

    OwnerGroupAlreadyInAlliance

    OwnerGroupAlreadyInAlliance: = 661
    @@ -5710,7 +5735,7 @@

    PSNExForbidden

    PSNExForbidden: = 1205
    @@ -5720,7 +5745,7 @@

    PSNExSystemDisabled

    PSNExSystemDisabled: = 1218
    @@ -5730,7 +5755,7 @@

    ParameterInvalidRange

    ParameterInvalidRange: = 8
    @@ -5740,7 +5765,7 @@

    ParameterNotFound

    ParameterNotFound: = 19
    @@ -5750,7 +5775,7 @@

    ParameterParseFailure

    ParameterParseFailure: = 7
    @@ -5760,7 +5785,7 @@

    PartnershipAccessFailure

    PartnershipAccessFailure: = 2203
    @@ -5770,7 +5795,7 @@

    PartnershipAccountInvalid

    PartnershipAccountInvalid: = 2204
    @@ -5780,7 +5805,7 @@

    PartnershipAlreadyExists

    PartnershipAlreadyExists: = 2207
    @@ -5790,7 +5815,7 @@

    PartnershipDisabled

    PartnershipDisabled: = 2206
    @@ -5800,7 +5825,7 @@

    PartnershipGetAccountInfoFailure

    PartnershipGetAccountInfoFailure: = 2205
    @@ -5810,7 +5835,7 @@

    PartnershipInvalidType

    PartnershipInvalidType: = 2200
    @@ -5820,7 +5845,7 @@

    PartnershipValidationError

    PartnershipValidationError: = 2201
    @@ -5830,7 +5855,7 @@

    PartnershipValidationTimeout

    PartnershipValidationTimeout: = 2202
    @@ -5840,7 +5865,7 @@

    PerEndpointRequestThrottleExceeded

    PerEndpointRequestThrottleExceeded: = 51
    @@ -5850,7 +5875,7 @@

    PrivateMessagingRequiresDestinyMembership

    PrivateMessagingRequiresDestinyMembership: = 313
    @@ -5860,7 +5885,7 @@

    PsnApiAccessTokenRequired

    PsnApiAccessTokenRequired: = 1226
    @@ -5870,7 +5895,7 @@

    PsnApiAccountAttributeMissing

    PsnApiAccountAttributeMissing: = 1237
    @@ -5880,7 +5905,7 @@

    PsnApiAccountUpgradeRequired

    PsnApiAccountUpgradeRequired: = 1230
    @@ -5890,7 +5915,7 @@

    PsnApiBadRequest

    PsnApiBadRequest: = 1225
    @@ -5900,7 +5925,7 @@

    PsnApiBannedUser

    PsnApiBannedUser: = 1229
    @@ -5910,7 +5935,7 @@

    PsnApiErrorCodeUnknown

    PsnApiErrorCodeUnknown: = 1223
    @@ -5920,7 +5945,7 @@

    PsnApiErrorWebException

    PsnApiErrorWebException: = 1224
    @@ -5930,7 +5955,7 @@

    PsnApiExpiredAccessToken

    PsnApiExpiredAccessToken: = 1204
    @@ -5940,7 +5965,7 @@

    PsnApiInvalidAccessToken

    PsnApiInvalidAccessToken: = 1227
    @@ -5950,7 +5975,7 @@

    PsnApiNoPermission

    PsnApiNoPermission: = 1238
    @@ -5960,7 +5985,7 @@

    PsnApiProfilePrivacyRestriction

    PsnApiProfilePrivacyRestriction: = 1235
    @@ -5970,7 +5995,7 @@

    PsnApiProfileUnderMaintenance

    PsnApiProfileUnderMaintenance: = 1236
    @@ -5980,7 +6005,7 @@

    PsnApiProfileUserNotFound

    PsnApiProfileUserNotFound: = 1234
    @@ -5990,7 +6015,7 @@

    PsnApiServerBusy

    PsnApiServerBusy: = 1232
    @@ -6000,7 +6025,7 @@

    PsnApiServiceTemporarilyUnavailable

    PsnApiServiceTemporarilyUnavailable: = 1231
    @@ -6010,7 +6035,7 @@

    PsnApiTargetUserBlocked

    PsnApiTargetUserBlocked: = 1239
    @@ -6020,7 +6045,7 @@

    PsnApiUnderMaintenance

    PsnApiUnderMaintenance: = 1233
    @@ -6030,7 +6055,7 @@

    RAFCannotBondToSelf

    RAFCannotBondToSelf: = 2032
    @@ -6040,7 +6065,7 @@

    RAFCodeAlreadyClaimedOrNotFound

    RAFCodeAlreadyClaimedOrNotFound: = 2026
    @@ -6050,7 +6075,7 @@

    RAFDuplicateBond

    RAFDuplicateBond: = 2023
    @@ -6060,7 +6085,7 @@

    RAFExceededMaximumReferrals

    RAFExceededMaximumReferrals: = 2022
    @@ -6070,7 +6095,7 @@

    RAFGenerateThrottled

    RAFGenerateThrottled: = 2034
    @@ -6080,7 +6105,7 @@

    RAFInvalidPlatform

    RAFInvalidPlatform: = 2033
    @@ -6090,7 +6115,7 @@

    RAFMismatchedDestinyMembershipType

    RAFMismatchedDestinyMembershipType: = 2027
    @@ -6100,7 +6125,7 @@

    RAFNoValidVeteranDestinyMembershipsFound

    RAFNoValidVeteranDestinyMembershipsFound: = 2024
    @@ -6110,7 +6135,7 @@

    RAFNotAValidVeteranUser

    RAFNotAValidVeteranUser: = 2025
    @@ -6120,7 +6145,7 @@

    RAFQuestEntitlementRequiresBnet

    RAFQuestEntitlementRequiresBnet: = 2052
    @@ -6130,7 +6155,7 @@

    RAFQuestEntitlementTransportFailure

    RAFQuestEntitlementTransportFailure: = 2053
    @@ -6140,7 +6165,7 @@

    RAFQuestEntitlementUnknownFailure

    RAFQuestEntitlementUnknownFailure: = 2054
    @@ -6150,7 +6175,7 @@

    RAFRedeemThrottled

    RAFRedeemThrottled: = 2037
    @@ -6160,7 +6185,7 @@

    RAFTooEarlyToCancelBond

    RAFTooEarlyToCancelBond: = 2056
    @@ -6170,7 +6195,7 @@

    RAFUnableToAccessPurchaseHistory

    RAFUnableToAccessPurchaseHistory: = 2028
    @@ -6180,7 +6205,7 @@

    RAFUnableToCreateBond

    RAFUnableToCreateBond: = 2029
    @@ -6190,7 +6215,7 @@

    RAFUnableToCreateBondVersionMismatch

    RAFUnableToCreateBondVersionMismatch: = 2035
    @@ -6200,7 +6225,7 @@

    RAFUnableToFindBond

    RAFUnableToFindBond: = 2030
    @@ -6210,7 +6235,7 @@

    RAFUnableToRemoveBond

    RAFUnableToRemoveBond: = 2031
    @@ -6220,7 +6245,7 @@

    RAFUnableToRemoveBondVersionMismatch

    RAFUnableToRemoveBondVersionMismatch: = 2036
    @@ -6230,7 +6255,7 @@

    RAFVeteranRewardUnknownFailure

    RAFVeteranRewardUnknownFailure: = 2055
    @@ -6240,7 +6265,7 @@

    RefreshTokenNotYetValid

    RefreshTokenNotYetValid: = 2110
    @@ -6250,7 +6275,7 @@

    ReportAlreadyReported

    ReportAlreadyReported: = 1403
    @@ -6260,7 +6285,7 @@

    ReportCannotReportSelf

    ReportCannotReportSelf: = 2703
    @@ -6270,7 +6295,7 @@

    ReportInvalidResolution

    ReportInvalidResolution: = 1404
    @@ -6280,7 +6305,7 @@

    ReportNotAssignedToYou

    ReportNotAssignedToYou: = 1405
    @@ -6290,7 +6315,7 @@

    ReportNotFound

    ReportNotFound: = 1402
    @@ -6300,7 +6325,7 @@

    ReportNotYetResolved

    ReportNotYetResolved: = 1400
    @@ -6310,7 +6335,7 @@

    ReportOffenderNotInPgcr

    ReportOffenderNotInPgcr: = 2700
    @@ -6320,7 +6345,7 @@

    ReportOverturnDoesNotChangeDecision

    ReportOverturnDoesNotChangeDecision: = 1401
    @@ -6330,7 +6355,7 @@

    ReportRequestorNotInPgcr

    ReportRequestorNotInPgcr: = 2701
    @@ -6340,7 +6365,7 @@

    ReportSubmissionFailed

    ReportSubmissionFailed: = 2702
    @@ -6350,7 +6375,7 @@

    ServiceRetired

    ServiceRetired: = 43
    @@ -6360,7 +6385,7 @@

    ServiceUnsupported

    ServiceUnsupported: = 48
    @@ -6370,7 +6395,7 @@

    ShareAlreadyShared

    ShareAlreadyShared: = 706
    @@ -6380,7 +6405,7 @@

    SingleTagExpected

    SingleTagExpected: = 908
    @@ -6390,7 +6415,7 @@

    Success

    Success: = 1
    @@ -6400,7 +6425,7 @@

    SystemDisabled

    SystemDisabled: = 5
    @@ -6410,7 +6435,7 @@

    TagFollowLimitExceeded

    TagFollowLimitExceeded: = 805
    @@ -6420,7 +6445,7 @@

    TagInvalid

    TagInvalid: = 906
    @@ -6430,7 +6455,7 @@

    TagNotFound

    TagNotFound: = 907
    @@ -6440,7 +6465,7 @@

    TagSuggestionsUnknownSqlResult

    TagSuggestionsUnknownSqlResult: = 904
    @@ -6450,7 +6475,7 @@

    TagsExceededMaximumPerItem

    TagsExceededMaximumPerItem: = 909
    @@ -6460,7 +6485,7 @@

    TagsUnableToLoadPopularTagsFromDatabase

    TagsUnableToLoadPopularTagsFromDatabase: = 905
    @@ -6470,7 +6495,7 @@

    ThrottleLimitExceeded

    ThrottleLimitExceeded: = 31
    @@ -6480,7 +6505,7 @@

    ThrottleLimitExceededMinutes

    ThrottleLimitExceededMinutes: = 35
    @@ -6490,7 +6515,7 @@

    ThrottleLimitExceededMomentarily

    ThrottleLimitExceededMomentarily: = 36
    @@ -6500,7 +6525,7 @@

    ThrottleLimitExceededSeconds

    ThrottleLimitExceededSeconds: = 37
    @@ -6510,7 +6535,7 @@

    TokenAlreadyClaimed

    TokenAlreadyClaimed: = 2002
    @@ -6520,7 +6545,7 @@

    TokenAlreadyClaimedSelf

    TokenAlreadyClaimedSelf: = 2003
    @@ -6530,7 +6555,7 @@

    TokenBadFormat

    TokenBadFormat: = 2001
    @@ -6540,7 +6565,7 @@

    TokenEmailNotValidated

    TokenEmailNotValidated: = 2009
    @@ -6550,7 +6575,7 @@

    TokenExceededOfferMaximum

    TokenExceededOfferMaximum: = 2014
    @@ -6560,7 +6585,7 @@

    TokenInvalid

    TokenInvalid: = 2000
    @@ -6570,7 +6595,7 @@

    TokenInvalidOfferKey

    TokenInvalidOfferKey: = 2008
    @@ -6580,7 +6605,7 @@

    TokenMarketplaceInvalidPlatform

    TokenMarketplaceInvalidPlatform: = 2016
    @@ -6590,7 +6615,7 @@

    TokenMarketplaceInvalidRegion

    TokenMarketplaceInvalidRegion: = 2020
    @@ -6600,7 +6625,7 @@

    TokenNoAvailableUnlocks

    TokenNoAvailableUnlocks: = 2015
    @@ -6610,7 +6635,7 @@

    TokenNoMarketplaceCodesFound

    TokenNoMarketplaceCodesFound: = 2017
    @@ -6620,7 +6645,7 @@

    TokenOfferExpired

    TokenOfferExpired: = 2021
    @@ -6630,7 +6655,7 @@

    TokenOfferNotAvailableForRedemption

    TokenOfferNotAvailableForRedemption: = 2018
    @@ -6640,7 +6665,7 @@

    TokenProvisioningBadVendorOrOffer

    TokenProvisioningBadVendorOrOffer: = 2010
    @@ -6650,7 +6675,7 @@

    TokenPurchaseClaimFailedAfterTokenClaimed

    TokenPurchaseClaimFailedAfterTokenClaimed: = 2006
    @@ -6660,7 +6685,7 @@

    TokenPurchaseHistoryUnknownError

    TokenPurchaseHistoryUnknownError: = 2011
    @@ -6670,7 +6695,7 @@

    TokenRequiresCredentialPsnid

    TokenRequiresCredentialPsnid: = 2045
    @@ -6680,7 +6705,7 @@

    TokenRequiresCredentialXuid

    TokenRequiresCredentialXuid: = 2044
    @@ -6690,7 +6715,7 @@

    TokenThrottleStateUnknownError

    TokenThrottleStateUnknownError: = 2012
    @@ -6700,7 +6725,7 @@

    TokenThrottling

    TokenThrottling: = 2004
    @@ -6710,7 +6735,7 @@

    TokenUnknownRedemptionFailure

    TokenUnknownRedemptionFailure: = 2005
    @@ -6720,7 +6745,7 @@

    TokenUnlockPartialFailure

    TokenUnlockPartialFailure: = 2019
    @@ -6730,7 +6755,7 @@

    TokenUserAgeNotVerified

    TokenUserAgeNotVerified: = 2013
    @@ -6740,7 +6765,17 @@

    TokenUserAlreadyOwnsOffer

    TokenUserAlreadyOwnsOffer: = 2007
    + +
    + +

    TransactionEmailSendFailure

    +
    TransactionEmailSendFailure: = 230
    +
    @@ -6750,7 +6785,7 @@

    TransportException

    TransportException: = 2
    @@ -6760,7 +6795,7 @@

    TrendingCategoryNotFound

    TrendingCategoryNotFound: = 2600
    @@ -6770,7 +6805,7 @@

    TrendingEntryTypeNotSupported

    TrendingEntryTypeNotSupported: = 2601
    @@ -6780,7 +6815,7 @@

    TwitchAccountNotFound

    TwitchAccountNotFound: = 2501
    @@ -6790,7 +6825,7 @@

    TwitchCouldNotLoadDestinyInfo

    TwitchCouldNotLoadDestinyInfo: = 2502
    @@ -6800,7 +6835,7 @@

    TwitchNotLinked

    TwitchNotLinked: = 2500
    @@ -6810,7 +6845,7 @@

    UnableToPairMobileApp

    UnableToPairMobileApp: = 91
    @@ -6820,7 +6855,7 @@

    UnableToUnPairMobileApp

    UnableToUnPairMobileApp: = 90
    @@ -6830,7 +6865,7 @@

    UnhandledException

    UnhandledException: = 3
    @@ -6840,7 +6875,7 @@

    UnhandledHttpException

    UnhandledHttpException: = 20
    @@ -6850,7 +6885,7 @@

    UnknownAuthenticationError

    UnknownAuthenticationError: = 97
    @@ -6860,7 +6895,7 @@

    UnknownEververseHistoryError

    UnknownEververseHistoryError: = 2047
    @@ -6870,7 +6905,7 @@

    UnknownSqlException

    UnknownSqlException: = 44
    @@ -6880,7 +6915,7 @@

    UnknownSqlResult

    UnknownSqlResult: = 14
    @@ -6895,7 +6930,7 @@

    UnsupportedLocale

    UnsupportedLocale: = 45
    @@ -6905,7 +6940,7 @@

    UserAcknowledgmentTableFull

    UserAcknowledgmentTableFull: = 225
    @@ -6915,7 +6950,7 @@

    UserBanned

    UserBanned: = 24
    @@ -6925,7 +6960,7 @@

    UserCannotChangeDisplayNameYet

    UserCannotChangeDisplayNameYet: = 221
    @@ -6935,7 +6970,7 @@

    UserCannotChangeEmail

    UserCannotChangeEmail: = 222
    @@ -6945,7 +6980,7 @@

    UserCannotChangeUniqueNameYet

    UserCannotChangeUniqueNameYet: = 220
    @@ -6955,7 +6990,7 @@

    UserCannotCreateNewAccountWhileLoggedInUserCannotCreateNewAccountWhileLoggedIn: = 216

    @@ -6965,7 +7000,7 @@

    UserCannotFindRequestedUser

    UserCannotFindRequestedUser: = 205
    @@ -6975,7 +7010,7 @@

    UserCannotGenerateMobileKeyWhileUsingMobi
    UserCannotGenerateMobileKeyWhileUsingMobileCredential: = 209
    @@ -6985,7 +7020,7 @@

    UserCannotLoadAccountCredentialLinkInfo

    UserCannotLoadAccountCredentialLinkInfo: = 206
    @@ -6995,7 +7030,7 @@

    UserCannotLoadAccountProfileData

    UserCannotLoadAccountProfileData: = 212
    @@ -7005,7 +7040,7 @@

    UserCannotResolveCentralAccount

    UserCannotResolveCentralAccount: = 217
    @@ -7015,7 +7050,7 @@

    UserCannotSaveUserProfileData

    UserCannotSaveUserProfileData: = 213
    @@ -7025,7 +7060,7 @@

    UserCreateUnknownSqlException

    UserCreateUnknownSqlException: = 203
    @@ -7035,7 +7070,7 @@

    UserCreateUnknownSqlResult

    UserCreateUnknownSqlResult: = 202
    @@ -7045,7 +7080,7 @@

    UserCreationDestinyMembershipRequired

    UserCreationDestinyMembershipRequired: = 226
    @@ -7055,7 +7090,7 @@

    UserDisplayNameMissingOrInvalid

    UserDisplayNameMissingOrInvalid: = 211
    @@ -7065,7 +7100,27 @@

    UserEmailMissingOrInvalid

    UserEmailMissingOrInvalid: = 214
    + +
    + +

    UserEmailValidationLimit

    +
    UserEmailValidationLimit: = 229
    + +
    +
    + +

    UserEmailValidationUnknown

    +
    UserEmailValidationUnknown: = 228
    +
    @@ -7075,7 +7130,7 @@

    UserFollowLimitExceeded

    UserFollowLimitExceeded: = 806
    @@ -7085,7 +7140,7 @@

    UserFriendsTokenNeedsRefresh

    UserFriendsTokenNeedsRefresh: = 227
    @@ -7095,7 +7150,7 @@

    UserGenerateMobileKeyExistingSlotCollision

    UserGenerateMobileKeyExistingSlotCollision: = 210
    @@ -7105,7 +7160,7 @@

    UserInvalidAvatar

    UserInvalidAvatar: = 218
    @@ -7115,7 +7170,7 @@

    UserInvalidMobileAppType

    UserInvalidMobileAppType: = 207
    @@ -7125,7 +7180,7 @@

    UserMalformedMembershipId

    UserMalformedMembershipId: = 204
    @@ -7135,7 +7190,7 @@

    UserManualLinkingStepRequired

    UserManualLinkingStepRequired: = 201
    @@ -7145,7 +7200,7 @@

    UserMissingCreatedUserResult

    UserMissingCreatedUserResult: = 219
    @@ -7155,7 +7210,7 @@

    UserMissingMobilePairingInfo

    UserMissingMobilePairingInfo: = 208
    @@ -7165,7 +7220,7 @@

    UserNoLinkedAccountsSupportFriendListings

    UserNoLinkedAccountsSupportFriendListings: = 224
    @@ -7175,7 +7230,7 @@

    UserNonUniqueName

    UserNonUniqueName: = 200
    @@ -7185,7 +7240,7 @@

    UserTermsOfUseRequired

    UserTermsOfUseRequired: = 215
    @@ -7195,7 +7250,7 @@

    UserUniqueNameMustStartWithLetter

    UserUniqueNameMustStartWithLetter: = 223
    @@ -7205,7 +7260,7 @@

    ValidationBadNames

    ValidationBadNames: = 41
    @@ -7215,7 +7270,7 @@

    ValidationError

    ValidationError: = 15
    @@ -7225,7 +7280,7 @@

    ValidationInvalidInputError

    ValidationInvalidInputError: = 17
    @@ -7235,7 +7290,7 @@

    ValidationInvisibleUnicode

    ValidationInvisibleUnicode: = 40
    @@ -7245,7 +7300,7 @@

    ValidationLengthError

    ValidationLengthError: = 28
    @@ -7255,7 +7310,7 @@

    ValidationMaximumSequentialCarriageReturns

    ValidationMaximumSequentialCarriageReturns: = 50
    @@ -7265,7 +7320,7 @@

    ValidationMaximumUnicodeCombiningCharacters

    ValidationMaximumUnicodeCombiningCharacters: = 49
    @@ -7275,7 +7330,7 @@

    ValidationMissingFieldError

    ValidationMissingFieldError: = 16
    @@ -7285,7 +7340,7 @@

    ValidationProfanityError

    ValidationProfanityError: = 33
    @@ -7295,7 +7350,7 @@

    ValidationRangeError

    ValidationRangeError: = 29
    @@ -7305,7 +7360,7 @@

    ValidationTagError

    ValidationTagError: = 32
    @@ -7315,7 +7370,7 @@

    ValidationUrlFormatError

    ValidationUrlFormatError: = 34
    @@ -7325,7 +7380,7 @@

    ValidationWordLengthError

    ValidationWordLengthError: = 39
    @@ -7335,7 +7390,7 @@

    WebAuthModuleAsyncFailed

    WebAuthModuleAsyncFailed: = 22
    @@ -7345,7 +7400,7 @@

    WebAuthRequired

    WebAuthRequired: = 99
    @@ -7355,7 +7410,7 @@

    XblAccessToTheSandboxDenied

    XblAccessToTheSandboxDenied: = 1306
    @@ -7365,7 +7420,7 @@

    XblApiErrorWebException

    XblApiErrorWebException: = 1302
    @@ -7375,7 +7430,7 @@

    XblDeveloperAccount

    XblDeveloperAccount: = 1313
    @@ -7385,7 +7440,7 @@

    XblExSystemDisabled

    XblExSystemDisabled: = 1300
    @@ -7395,7 +7450,7 @@

    XblExUnknownError

    XblExUnknownError: = 1301
    @@ -7405,7 +7460,7 @@

    XblMsaAccessTokenExpired

    XblMsaAccessTokenExpired: = 1308
    @@ -7415,7 +7470,7 @@

    XblMsaFriendsRequireSignIn

    XblMsaFriendsRequireSignIn: = 1310
    @@ -7425,7 +7480,7 @@

    XblMsaInvalidGrant

    XblMsaInvalidGrant: = 1318
    @@ -7435,7 +7490,7 @@

    XblMsaInvalidRequest

    XblMsaInvalidRequest: = 1309
    @@ -7445,7 +7500,7 @@

    XblMsaResponseMissing

    XblMsaResponseMissing: = 1307
    @@ -7455,7 +7510,7 @@

    XblOffline

    XblOffline: = 1316
    @@ -7465,7 +7520,7 @@

    XblParentalControls

    XblParentalControls: = 1312
    @@ -7475,7 +7530,7 @@

    XblStsExpiredToken

    XblStsExpiredToken: = 1305
    @@ -7485,7 +7540,7 @@

    XblStsMissingToken

    XblStsMissingToken: = 1304
    @@ -7495,7 +7550,7 @@

    XblStsTokenInvalid

    XblStsTokenInvalid: = 1303
    @@ -7505,7 +7560,7 @@

    XblUnknownErrorCode

    XblUnknownErrorCode: = 1317
    @@ -7515,7 +7570,7 @@

    XblUserActionRequired

    XblUserActionRequired: = 1311
    @@ -7525,7 +7580,7 @@

    XblUserTokenExpired

    XblUserTokenExpired: = 1314
    @@ -7535,7 +7590,7 @@

    XblUserTokenInvalid

    XblUserTokenInvalid: = 1315
    @@ -7733,6 +7788,9 @@

    XblUserTokenInvalid

  • ClanFireteamCannotAdjustSlotCount
  • +
  • + ClanFireteamExpired +
  • ClanFireteamFull
  • @@ -7841,6 +7899,9 @@

    XblUserTokenInvalid

  • ClanNameReserved
  • +
  • + ClanNameRestricted +
  • ClanNotEnabledAlreadyMemberOfAnotherClan
  • @@ -9350,6 +9411,9 @@

    XblUserTokenInvalid

  • TokenUserAlreadyOwnsOffer
  • +
  • + TransactionEmailSendFailure +
  • TransportException
  • @@ -9446,6 +9510,12 @@

    XblUserTokenInvalid

  • UserEmailMissingOrInvalid
  • +
  • + UserEmailValidationLimit +
  • +
  • + UserEmailValidationUnknown +
  • UserFollowLimitExceeded
  • diff --git a/docs/enums/plugavailabilitymode.html b/docs/enums/plugavailabilitymode.html index c531299..bf77670 100644 --- a/docs/enums/plugavailabilitymode.html +++ b/docs/enums/plugavailabilitymode.html @@ -66,6 +66,25 @@

    Enumeration PlugAvailabilityMode

    +
    +
    +
    +

    This enum determines whether the plug is available to be inserted.

    +
    +
      +
    • Normal means that all existing rules for plug insertion apply.

      +
    • +
    • UnavailableIfSocketContainsMatchingPlugCategory means that the plug is only + available if the socket does NOT match the plug category.

      +
    • +
    • AvailableIfSocketContainsMatchingPlugCategory means that the plug is only + available if the socket DOES match the plug category.

      +
    • +
    +

    For category matching, use the plug's "plugCategoryIdentifier" property, + comparing it to

    +
    +

    Index

    @@ -89,7 +108,7 @@

    AvailableIfSocketContainsMatchingPlugCategory

    AvailableIfSocketContainsMatchingPlugCategory: = 2
    @@ -99,7 +118,7 @@

    Normal

    Normal: = 0
    @@ -109,7 +128,7 @@

    UnavailableIfSocketContainsMatchingPlugCategory

    UnavailableIfSocketContainsMatchingPlugCategory: = 1
    diff --git a/docs/enums/pluguistyles.html b/docs/enums/pluguistyles.html index 7287b4a..c6d0350 100644 --- a/docs/enums/pluguistyles.html +++ b/docs/enums/pluguistyles.html @@ -66,6 +66,16 @@

    Enumeration PlugUiStyles

    +
    +
    +
    +

    If the plug has a specific custom style, this enumeration will represent that + style/those styles.

    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +

    Index

    @@ -88,7 +98,7 @@

    Masterwork

    Masterwork: = 1
    @@ -98,7 +108,7 @@

    None

    None: = 0
    diff --git a/docs/enums/runtimegroupmembertype.html b/docs/enums/runtimegroupmembertype.html index 2b884b8..637842f 100644 --- a/docs/enums/runtimegroupmembertype.html +++ b/docs/enums/runtimegroupmembertype.html @@ -66,6 +66,17 @@

    Enumeration RuntimeGroupMemberType

    +
    +
    +
    +

    The member levels used by all V2 Groups API. Individual group types use their + own mappings in their native storage (general uses BnetDbGroupMemberType and D2 + clans use ClanMemberLevel), but they are all translated to this in the runtime + api. These runtime values should NEVER be stored anywhere, so the values can be + changed as necessary.

    +
    +
    +

    Index

    @@ -92,7 +103,7 @@

    ActingFounder

    ActingFounder: = 4
    @@ -102,7 +113,7 @@

    Admin

    Admin: = 3
    @@ -112,7 +123,7 @@

    Beginner

    Beginner: = 1
    @@ -122,7 +133,7 @@

    Founder

    Founder: = 5
    @@ -132,7 +143,7 @@

    Member

    Member: = 2
    @@ -142,7 +153,7 @@

    None

    None: = 0
    diff --git a/docs/enums/socketplugsources.html b/docs/enums/socketplugsources.html index bcb98c4..0654541 100644 --- a/docs/enums/socketplugsources.html +++ b/docs/enums/socketplugsources.html @@ -66,6 +66,17 @@

    Enumeration SocketPlugSources

    +
    +
    +
    +

    Indicates how a socket is populated, and where you should look for valid plug + data. This is a flags enumeration/bitmask field, as you may have to look in + multiple sources across multiple components for valid plugs.

    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +

    Index

    @@ -91,7 +102,7 @@

    CharacterPlugSet

    CharacterPlugSet: = 8
    @@ -107,7 +118,7 @@

    InventorySourced

    InventorySourced: = 1
    @@ -125,7 +136,7 @@

    None

    None: = 0
    @@ -140,7 +151,7 @@

    ProfilePlugSet

    ProfilePlugSet: = 4
    @@ -156,7 +167,7 @@

    ReusablePlugItems

    ReusablePlugItems: = 2
    diff --git a/docs/enums/sockettypeactiontype.html b/docs/enums/sockettypeactiontype.html index 37f22d7..14c5c84 100644 --- a/docs/enums/sockettypeactiontype.html +++ b/docs/enums/sockettypeactiontype.html @@ -66,6 +66,13 @@

    Enumeration SocketTypeActionType

    +
    +
    +
    +

    Indicates the type of actions that can be performed

    +
    +
    +

    Index

    @@ -89,7 +96,7 @@

    InfuseItem

    InfuseItem: = 1
    @@ -99,7 +106,7 @@

    InsertPlug

    InsertPlug: = 0
    @@ -109,7 +116,7 @@

    ReinitializeSocket

    ReinitializeSocket: = 2
    diff --git a/docs/enums/specialitemtype.html b/docs/enums/specialitemtype.html index 91700e4..9b9fda3 100644 --- a/docs/enums/specialitemtype.html +++ b/docs/enums/specialitemtype.html @@ -66,6 +66,17 @@

    Enumeration SpecialItemType

    +
    +
    +
    +

    As you run into items that need to be classified for Milestone purposes in ways + that we cannot infer via direct data, add a new classification here and use a + string constant to represent it in the local item config file.

    +
    +

    NOTE: This is not all of the item types available, and some of these are + holdovers from Destiny 1 that may or may not still exist.

    +
    +

    Index

    @@ -95,7 +106,7 @@

    Armor

    Armor: = 8
    @@ -105,7 +116,7 @@

    Consumable

    Consumable: = 24
    @@ -115,7 +126,7 @@

    Currency

    Currency: = 29
    @@ -125,7 +136,7 @@

    Engram

    Engram: = 23
    @@ -135,7 +146,7 @@

    ExchangeMaterial

    ExchangeMaterial: = 25
    @@ -145,7 +156,7 @@

    MissionReward

    MissionReward: = 27
    @@ -155,7 +166,7 @@

    None

    None: = 0
    @@ -165,7 +176,7 @@

    SpecialCurrency

    SpecialCurrency: = 1
    @@ -175,7 +186,7 @@

    Weapon

    Weapon: = 9
    diff --git a/docs/enums/statid.html b/docs/enums/statid.html index 28745d2..87d9bb2 100644 --- a/docs/enums/statid.html +++ b/docs/enums/statid.html @@ -325,7 +325,7 @@

    ActivitiesClearedabilityKills

    ActivitiesClearedabilityKills: = "DestinyInventoryItemDefinition"
    @@ -335,7 +335,7 @@

    ActivitiesEntered

    ActivitiesEntered: = "ActivitiesEntered"
    @@ -345,7 +345,7 @@

    ActivitiesWon

    ActivitiesWon: = "ActivitiesWon"
    @@ -355,7 +355,7 @@

    ActivityAssists

    ActivityAssists: = "ActivityAssists"
    @@ -365,7 +365,7 @@

    ActivityBestGoalsHit

    ActivityBestGoalsHit: = "ActivityBestGoalsHit"
    @@ -375,7 +375,7 @@

    ActivityBestSingleGameScore

    ActivityBestSingleGameScore: = "ActivityBestSingleGameScore"
    @@ -385,7 +385,7 @@

    ActivityCompletedFailures

    ActivityCompletedFailures: = "ActivityCompletedFailures"
    @@ -395,7 +395,7 @@

    ActivityCompletions

    ActivityCompletions: = "ActivityCompletions"
    @@ -405,7 +405,7 @@

    ActivityDeaths

    ActivityDeaths: = "ActivityDeaths"
    @@ -415,7 +415,7 @@

    ActivityDurationSeconds

    ActivityDurationSeconds: = "ActivityDurationSeconds"
    @@ -425,7 +425,7 @@

    ActivityFastestObjectiveCompletionMs

    ActivityFastestObjectiveCompletionMs: = "ActivityFastestObjectiveCompletionMs"
    @@ -435,7 +435,7 @@

    ActivityGatesHit

    ActivityGatesHit: = "ActivityGatesHit"
    @@ -445,7 +445,7 @@

    ActivityGoalsMissed

    ActivityGoalsMissed: = "ActivityGoalsMissed"
    @@ -455,7 +455,7 @@

    ActivityKills

    ActivityKills: = "ActivityKills"
    @@ -465,7 +465,7 @@

    ActivityKillsDeathsAssists

    ActivityKillsDeathsAssists: = "ActivityKillsDeathsAssists"
    @@ -475,7 +475,7 @@

    ActivityKillsDeathsRatio

    ActivityKillsDeathsRatio: = "ActivityKillsDeathsRatio"
    @@ -485,7 +485,7 @@

    ActivityPrecisionKills

    ActivityPrecisionKills: = "ActivityPrecisionKills"
    @@ -495,7 +495,7 @@

    ActivitySecondsPlayed

    ActivitySecondsPlayed: = "ActivitySecondsPlayed"
    @@ -505,7 +505,7 @@

    ActivitySpecialActions

    ActivitySpecialActions: = "ActivitySpecialActions"
    @@ -515,7 +515,7 @@

    ActivitySpecialScore

    ActivitySpecialScore: = "ActivitySpecialScore"
    @@ -525,7 +525,7 @@

    ActivityWins

    ActivityWins: = "ActivityWins"
    @@ -535,7 +535,7 @@

    AllMedalsEarned

    AllMedalsEarned: = "AllMedalsEarned"
    @@ -545,7 +545,7 @@

    AllMedalsScore

    AllMedalsScore: = "AllMedalsScore"
    @@ -555,7 +555,7 @@

    AllParticipantsCount

    AllParticipantsCount: = "AllParticipantsCount"
    @@ -565,7 +565,7 @@

    AllParticipantsScore

    AllParticipantsScore: = "AllParticipantsScore"
    @@ -575,7 +575,7 @@

    AllParticipantsTimePlayed

    AllParticipantsTimePlayed: = "AllParticipantsTimePlayed"
    @@ -585,7 +585,7 @@

    Assists

    Assists: = "Assists"
    @@ -595,7 +595,7 @@

    AverageDeathDistance

    AverageDeathDistance: = "AverageDeathDistance"
    @@ -605,7 +605,7 @@

    AverageKillDistance

    AverageKillDistance: = "AverageKillDistance"
    @@ -615,7 +615,7 @@

    AverageLifespan

    AverageLifespan: = "AverageLifespan"
    @@ -625,7 +625,7 @@

    AverageScorePerKill

    AverageScorePerKill: = "AverageScorePerKill"
    @@ -635,7 +635,7 @@

    AverageScorePerLife

    AverageScorePerLife: = "AverageScorePerLife"
    @@ -645,7 +645,7 @@

    BestSingleGameKills

    BestSingleGameKills: = "BestSingleGameKills"
    @@ -655,7 +655,7 @@

    BestSingleGameScore

    BestSingleGameScore: = "BestSingleGameScore"
    @@ -665,7 +665,7 @@

    CarrierKills

    CarrierKills: = "CarrierKills"
    @@ -675,7 +675,7 @@

    CombatRating

    CombatRating: = "CombatRating"
    @@ -685,7 +685,7 @@

    Completed

    Completed: = "Completed"
    @@ -695,7 +695,7 @@

    CompletionReason

    CompletionReason: = "CompletionReason"
    @@ -705,7 +705,7 @@

    DailyMedalsEarned

    DailyMedalsEarned: = "DailyMedalsEarned"
    @@ -715,7 +715,7 @@

    Deaths

    Deaths: = "Deaths"
    @@ -725,7 +725,7 @@

    DunkKills

    DunkKills: = "DunkKills"
    @@ -735,7 +735,7 @@

    FastestCompletionMs

    FastestCompletionMs: = "FastestCompletionMs"
    @@ -745,7 +745,7 @@

    FastestCompletionMsForActivity

    FastestCompletionMsForActivity: = "FastestCompletionMsForActivity"
    @@ -755,7 +755,7 @@

    FireteamId

    FireteamId: = "FireteamId"
    @@ -765,7 +765,7 @@

    GatesHit

    GatesHit: = "GatesHit"
    @@ -775,7 +775,7 @@

    HighestCharacterLevel

    HighestCharacterLevel: = "HighestCharacterLevel"
    @@ -785,7 +785,7 @@

    HighestLightLevel

    HighestLightLevel: = "HighestLightLevel"
    @@ -795,7 +795,7 @@

    HighestSandboxLevel

    HighestSandboxLevel: = "HighestSandboxLevel"
    @@ -805,7 +805,7 @@

    Kills

    Kills: = "Kills"
    @@ -815,7 +815,7 @@

    KillsDeathsAssists

    KillsDeathsAssists: = "KillsDeathsAssists"
    @@ -825,7 +825,7 @@

    KillsDeathsRatio

    KillsDeathsRatio: = "KillsDeathsRatio"
    @@ -835,7 +835,7 @@

    LbAssists

    LbAssists: = "LbAssists"
    @@ -845,7 +845,7 @@

    LbDeaths

    LbDeaths: = "LbDeaths"
    @@ -855,7 +855,7 @@

    LbFastestCompletionMs

    LbFastestCompletionMs: = "LbFastestCompletionMs"
    @@ -865,7 +865,7 @@

    LbKills

    LbKills: = "LbKills"
    @@ -875,7 +875,7 @@

    LbLongestKillDistance

    LbLongestKillDistance: = "LbLongestKillDistance"
    @@ -885,7 +885,7 @@

    LbLongestKillSpree

    LbLongestKillSpree: = "LbLongestKillSpree"
    @@ -895,7 +895,7 @@

    LbLongestSingleLife

    LbLongestSingleLife: = "LbLongestSingleLife"
    @@ -905,7 +905,7 @@

    LbMostPrecisionKills

    LbMostPrecisionKills: = "LbMostPrecisionKills"
    @@ -915,7 +915,7 @@

    LbObjectivesCompleted

    LbObjectivesCompleted: = "LbObjectivesCompleted"
    @@ -925,7 +925,7 @@

    LbPrecisionKills

    LbPrecisionKills: = "LbPrecisionKills"
    @@ -935,7 +935,7 @@

    LbSingleGameKills

    LbSingleGameKills: = "LbSingleGameKills"
    @@ -945,7 +945,7 @@

    LbSingleGameScore

    LbSingleGameScore: = "LbSingleGameScore"
    @@ -955,7 +955,7 @@

    LongestKillDistance

    LongestKillDistance: = "LongestKillDistance"
    @@ -965,7 +965,7 @@

    LongestKillSpree

    LongestKillSpree: = "LongestKillSpree"
    @@ -975,7 +975,7 @@

    LongestSingleLife

    LongestSingleLife: = "LongestSingleLife"
    @@ -985,7 +985,7 @@

    MaximumPowerLevel

    MaximumPowerLevel: = "MaximumPowerLevel"
    @@ -995,7 +995,7 @@

    MedalAbilityDawnbladeAerial

    MedalAbilityDawnbladeAerial: = "MedalAbilityDawnbladeAerial"
    @@ -1005,7 +1005,7 @@

    MedalAbilityDawnbladeSlam

    MedalAbilityDawnbladeSlam: = "MedalAbilityDawnbladeSlam"
    @@ -1015,7 +1015,7 @@

    MedalAbilityFlowwalkerMulti

    MedalAbilityFlowwalkerMulti: = "MedalAbilityFlowwalkerMulti"
    @@ -1025,7 +1025,7 @@

    MedalAbilityFlowwalkerQuick

    MedalAbilityFlowwalkerQuick: = "MedalAbilityFlowwalkerQuick"
    @@ -1035,7 +1035,7 @@

    MedalAbilityGunslingerMulti

    MedalAbilityGunslingerMulti: = "MedalAbilityGunslingerMulti"
    @@ -1045,7 +1045,7 @@

    MedalAbilityGunslingerQuick

    MedalAbilityGunslingerQuick: = "MedalAbilityGunslingerQuick"
    @@ -1055,7 +1055,7 @@

    MedalAbilityJuggernautCombo

    MedalAbilityJuggernautCombo: = "MedalAbilityJuggernautCombo"
    @@ -1065,7 +1065,7 @@

    MedalAbilityJuggernautSlam

    MedalAbilityJuggernautSlam: = "MedalAbilityJuggernautSlam"
    @@ -1075,7 +1075,7 @@

    MedalAbilityNightstalkerLongRange

    MedalAbilityNightstalkerLongRange: = "MedalAbilityNightstalkerLongRange"
    @@ -1085,7 +1085,7 @@

    MedalAbilityNightstalkerTetherQuick

    MedalAbilityNightstalkerTetherQuick: = "MedalAbilityNightstalkerTetherQuick"
    @@ -1095,7 +1095,7 @@

    MedalAbilitySentinelCombo

    MedalAbilitySentinelCombo: = "MedalAbilitySentinelCombo"
    @@ -1105,7 +1105,7 @@

    MedalAbilitySentinelWard

    MedalAbilitySentinelWard: = "MedalAbilitySentinelWard"
    @@ -1115,7 +1115,7 @@

    MedalAbilityStormcallerLandfall

    MedalAbilityStormcallerLandfall: = "MedalAbilityStormcallerLandfall"
    @@ -1125,7 +1125,7 @@

    MedalAbilityStormcallerMulti

    MedalAbilityStormcallerMulti: = "MedalAbilityStormcallerMulti"
    @@ -1135,7 +1135,7 @@

    MedalAbilitySunbreakerLongRange

    MedalAbilitySunbreakerLongRange: = "MedalAbilitySunbreakerLongRange"
    @@ -1145,7 +1145,7 @@

    MedalAbilitySunbreakerMulti

    MedalAbilitySunbreakerMulti: = "MedalAbilitySunbreakerMulti"
    @@ -1155,7 +1155,7 @@

    MedalAbilityVoidwalkerDistance

    MedalAbilityVoidwalkerDistance: = "MedalAbilityVoidwalkerDistance"
    @@ -1165,7 +1165,7 @@

    MedalAbilityVoidwalkerVortex

    MedalAbilityVoidwalkerVortex: = "MedalAbilityVoidwalkerVortex"
    @@ -1175,7 +1175,7 @@

    MedalAvenger

    MedalAvenger: = "MedalAvenger"
    @@ -1185,7 +1185,7 @@

    MedalControlAdvantageHold

    MedalControlAdvantageHold: = "MedalControlAdvantageHold"
    @@ -1195,7 +1195,7 @@

    MedalControlAdvantageStreak

    MedalControlAdvantageStreak: = "MedalControlAdvantageStreak"
    @@ -1205,7 +1205,7 @@

    MedalControlCaptureAllZones

    MedalControlCaptureAllZones: = "MedalControlCaptureAllZones"
    @@ -1215,7 +1215,7 @@

    MedalControlMostAdvantage

    MedalControlMostAdvantage: = "MedalControlMostAdvantage"
    @@ -1225,7 +1225,7 @@

    MedalControlPerimeterKill

    MedalControlPerimeterKill: = "MedalControlPerimeterKill"
    @@ -1235,7 +1235,7 @@

    MedalControlPowerPlayWipe

    MedalControlPowerPlayWipe: = "MedalControlPowerPlayWipe"
    @@ -1245,7 +1245,7 @@

    MedalCountdownDefense

    MedalCountdownDefense: = "MedalCountdownDefense"
    @@ -1255,7 +1255,7 @@

    MedalCountdownDefusedLastStand

    MedalCountdownDefusedLastStand: = "MedalCountdownDefusedLastStand"
    @@ -1265,7 +1265,7 @@

    MedalCountdownDefusedMulti

    MedalCountdownDefusedMulti: = "MedalCountdownDefusedMulti"
    @@ -1275,7 +1275,7 @@

    MedalCountdownDetonated

    MedalCountdownDetonated: = "MedalCountdownDetonated"
    @@ -1285,7 +1285,7 @@

    MedalCountdownPerfect

    MedalCountdownPerfect: = "MedalCountdownPerfect"
    @@ -1295,7 +1295,7 @@

    MedalCountdownRoundAllAlive

    MedalCountdownRoundAllAlive: = "MedalCountdownRoundAllAlive"
    @@ -1305,7 +1305,7 @@

    MedalCycle

    MedalCycle: = "MedalCycle"
    @@ -1315,7 +1315,7 @@

    MedalDefeatHunterDodge

    MedalDefeatHunterDodge: = "MedalDefeatHunterDodge"
    @@ -1325,7 +1325,7 @@

    MedalDefeatTitanBrace

    MedalDefeatTitanBrace: = "MedalDefeatTitanBrace"
    @@ -1335,7 +1335,7 @@

    MedalDefeatWarlockSigil

    MedalDefeatWarlockSigil: = "MedalDefeatWarlockSigil"
    @@ -1345,7 +1345,7 @@

    MedalDefense

    MedalDefense: = "MedalDefense"
    @@ -1355,7 +1355,7 @@

    MedalMatchBlowout

    MedalMatchBlowout: = "MedalMatchBlowout"
    @@ -1365,7 +1365,7 @@

    MedalMatchComeback

    MedalMatchComeback: = "MedalMatchComeback"
    @@ -1375,7 +1375,7 @@

    MedalMatchMostDamage

    MedalMatchMostDamage: = "MedalMatchMostDamage"
    @@ -1385,7 +1385,7 @@

    MedalMatchNeverTrailed

    MedalMatchNeverTrailed: = "MedalMatchNeverTrailed"
    @@ -1395,7 +1395,7 @@

    MedalMatchOvertime

    MedalMatchOvertime: = "MedalMatchOvertime"
    @@ -1405,7 +1405,7 @@

    MedalMatchUndefeated

    MedalMatchUndefeated: = "MedalMatchUndefeated"
    @@ -1415,7 +1415,7 @@

    MedalMulti2x

    MedalMulti2x: = "MedalMulti2x"
    @@ -1425,7 +1425,7 @@

    MedalMulti3x

    MedalMulti3x: = "MedalMulti3x"
    @@ -1435,7 +1435,7 @@

    MedalMulti4x

    MedalMulti4x: = "MedalMulti4x"
    @@ -1445,7 +1445,7 @@

    MedalMultiEntireTeam

    MedalMultiEntireTeam: = "MedalMultiEntireTeam"
    @@ -1455,7 +1455,7 @@

    MedalPayback

    MedalPayback: = "MedalPayback"
    @@ -1465,7 +1465,7 @@

    MedalQuickStrike

    MedalQuickStrike: = "MedalQuickStrike"
    @@ -1475,7 +1475,7 @@

    MedalStreak10x

    MedalStreak10x: = "MedalStreak10x"
    @@ -1485,7 +1485,7 @@

    MedalStreak5x

    MedalStreak5x: = "MedalStreak5x"
    @@ -1495,7 +1495,7 @@

    MedalStreakAbsurd

    MedalStreakAbsurd: = "MedalStreakAbsurd"
    @@ -1505,7 +1505,7 @@

    MedalStreakCombined

    MedalStreakCombined: = "MedalStreakCombined"
    @@ -1515,7 +1515,7 @@

    MedalStreakShutdown

    MedalStreakShutdown: = "MedalStreakShutdown"
    @@ -1525,7 +1525,7 @@

    MedalStreakTeam

    MedalStreakTeam: = "MedalStreakTeam"
    @@ -1535,7 +1535,7 @@

    MedalSuperShutdown

    MedalSuperShutdown: = "MedalSuperShutdown"
    @@ -1545,7 +1545,7 @@

    MedalSupremacyCrestCreditStreak

    MedalSupremacyCrestCreditStreak: = "MedalSupremacyCrestCreditStreak"
    @@ -1555,7 +1555,7 @@

    MedalSupremacyFirstCrest

    MedalSupremacyFirstCrest: = "MedalSupremacyFirstCrest"
    @@ -1565,7 +1565,7 @@

    MedalSupremacyNeverCollected

    MedalSupremacyNeverCollected: = "MedalSupremacyNeverCollected"
    @@ -1575,7 +1575,7 @@

    MedalSupremacyPerfectSecureRate

    MedalSupremacyPerfectSecureRate: = "MedalSupremacyPerfectSecureRate"
    @@ -1585,7 +1585,7 @@

    MedalSupremacyRecoverStreak

    MedalSupremacyRecoverStreak: = "MedalSupremacyRecoverStreak"
    @@ -1595,7 +1595,7 @@

    MedalSupremacySecureStreak

    MedalSupremacySecureStreak: = "MedalSupremacySecureStreak"
    @@ -1605,7 +1605,7 @@

    MedalSurvivalComeback

    MedalSurvivalComeback: = "MedalSurvivalComeback"
    @@ -1615,7 +1615,7 @@

    MedalSurvivalKnockout

    MedalSurvivalKnockout: = "MedalSurvivalKnockout"
    @@ -1625,7 +1625,7 @@

    MedalSurvivalQuickWipe

    MedalSurvivalQuickWipe: = "MedalSurvivalQuickWipe"
    @@ -1635,7 +1635,7 @@

    MedalSurvivalTeamUndefeated

    MedalSurvivalTeamUndefeated: = "MedalSurvivalTeamUndefeated"
    @@ -1645,7 +1645,7 @@

    MedalSurvivalUndefeated

    MedalSurvivalUndefeated: = "MedalSurvivalUndefeated"
    @@ -1655,7 +1655,7 @@

    MedalSurvivalWinLastStand

    MedalSurvivalWinLastStand: = "MedalSurvivalWinLastStand"
    @@ -1665,7 +1665,7 @@

    MedalWeaponAuto

    MedalWeaponAuto: = "MedalWeaponAuto"
    @@ -1675,7 +1675,7 @@

    MedalWeaponFusion

    MedalWeaponFusion: = "MedalWeaponFusion"
    @@ -1685,7 +1685,7 @@

    MedalWeaponGrenade

    MedalWeaponGrenade: = "MedalWeaponGrenade"
    @@ -1695,7 +1695,7 @@

    MedalWeaponHandCannon

    MedalWeaponHandCannon: = "MedalWeaponHandCannon"
    @@ -1705,7 +1705,7 @@

    MedalWeaponPulse

    MedalWeaponPulse: = "MedalWeaponPulse"
    @@ -1715,7 +1715,7 @@

    MedalWeaponRocket

    MedalWeaponRocket: = "MedalWeaponRocket"
    @@ -1725,7 +1725,7 @@

    MedalWeaponScout

    MedalWeaponScout: = "MedalWeaponScout"
    @@ -1735,7 +1735,7 @@

    MedalWeaponShotgun

    MedalWeaponShotgun: = "MedalWeaponShotgun"
    @@ -1745,7 +1745,7 @@

    MedalWeaponSidearm

    MedalWeaponSidearm: = "MedalWeaponSidearm"
    @@ -1755,7 +1755,7 @@

    MedalWeaponSmg

    MedalWeaponSmg: = "MedalWeaponSmg"
    @@ -1765,7 +1765,7 @@

    MedalWeaponSniper

    MedalWeaponSniper: = "MedalWeaponSniper"
    @@ -1775,7 +1775,7 @@

    MedalWeaponSword

    MedalWeaponSword: = "MedalWeaponSword"
    @@ -1785,7 +1785,7 @@

    MedalsUnknown

    MedalsUnknown: = "MedalsUnknown"
    @@ -1795,7 +1795,7 @@

    MostPrecisionKills

    MostPrecisionKills: = "MostPrecisionKills"
    @@ -1805,7 +1805,7 @@

    ObjectivesCompleted

    ObjectivesCompleted: = "ObjectivesCompleted"
    @@ -1815,7 +1815,7 @@

    OrbsDropped

    OrbsDropped: = "OrbsDropped"
    @@ -1825,7 +1825,7 @@

    OrbsGathered

    OrbsGathered: = "OrbsGathered"
    @@ -1835,7 +1835,7 @@

    PlayerCount

    PlayerCount: = "PlayerCount"
    @@ -1845,7 +1845,7 @@

    PrecisionKills

    PrecisionKills: = "PrecisionKills"
    @@ -1855,7 +1855,7 @@

    PublicEventsCompleted

    PublicEventsCompleted: = "PublicEventsCompleted"
    @@ -1865,7 +1865,7 @@

    PublicEventsJoined

    PublicEventsJoined: = "PublicEventsJoined"
    @@ -1875,7 +1875,7 @@

    RaceCompletionMilliseconds

    RaceCompletionMilliseconds: = "RaceCompletionMilliseconds"
    @@ -1885,7 +1885,7 @@

    RaceCompletionSeconds

    RaceCompletionSeconds: = "RaceCompletionSeconds"
    @@ -1895,7 +1895,7 @@

    RemainingTimeAfterQuitSeconds

    RemainingTimeAfterQuitSeconds: = "RemainingTimeAfterQuitSeconds"
    @@ -1905,7 +1905,7 @@

    ResurrectionsPerformed

    ResurrectionsPerformed: = "ResurrectionsPerformed"
    @@ -1915,7 +1915,7 @@

    ResurrectionsReceived

    ResurrectionsReceived: = "ResurrectionsReceived"
    @@ -1925,7 +1925,7 @@

    Score

    Score: = "Score"
    @@ -1935,7 +1935,7 @@

    SecondsPlayed

    SecondsPlayed: = "SecondsPlayed"
    @@ -1945,7 +1945,7 @@

    SlamDunks

    SlamDunks: = "SlamDunks"
    @@ -1955,7 +1955,7 @@

    SparksCaptured

    SparksCaptured: = "SparksCaptured"
    @@ -1965,7 +1965,7 @@

    Standing

    Standing: = "ActivityDurationSeconds"
    @@ -1975,7 +1975,7 @@

    StartSeconds

    StartSeconds: = "StartSeconds"
    @@ -1985,7 +1985,7 @@

    StyleDunks

    StyleDunks: = "StyleDunks"
    @@ -1995,7 +1995,7 @@

    Suicides

    Suicides: = "Suicides"
    @@ -2005,7 +2005,7 @@

    Team

    Team: = "Team"
    @@ -2015,7 +2015,7 @@

    TeamScore

    TeamScore: = "TeamScore"
    @@ -2025,7 +2025,7 @@

    TimePlayedSeconds

    TimePlayedSeconds: = "TimePlayedSeconds"
    @@ -2035,7 +2035,7 @@

    TotalActivityDurationSeconds

    TotalActivityDurationSeconds: = "TotalActivityDurationSeconds"
    @@ -2045,7 +2045,7 @@

    TotalDeathDistance

    TotalDeathDistance: = "TotalDeathDistance"
    @@ -2055,7 +2055,7 @@

    TotalKillDistance

    TotalKillDistance: = "TotalKillDistance"
    @@ -2065,7 +2065,7 @@

    UniqueWeaponAssistDamage

    UniqueWeaponAssistDamage: = "UniqueWeaponAssistDamage"
    @@ -2075,7 +2075,7 @@

    UniqueWeaponAssists

    UniqueWeaponAssists: = "UniqueWeaponAssists"
    @@ -2085,7 +2085,7 @@

    UniqueWeaponKills

    UniqueWeaponKills: = "UniqueWeaponKills"
    @@ -2095,7 +2095,7 @@

    UniqueWeaponKillsPrecisionKills

    UniqueWeaponKillsPrecisionKills: = "UniqueWeaponKillsPrecisionKills"
    @@ -2105,7 +2105,7 @@

    UniqueWeaponPrecisionKills

    UniqueWeaponPrecisionKills: = "UniqueWeaponPrecisionKills"
    @@ -2115,7 +2115,7 @@

    WeaponBestType

    WeaponBestType: = "WeaponBestType"
    @@ -2125,7 +2125,7 @@

    WeaponKillsAbility

    WeaponKillsAbility: = "WeaponKillsAbility"
    @@ -2135,7 +2135,7 @@

    WeaponKillsAutoRifle

    WeaponKillsAutoRifle: = "WeaponKillsAutoRifle"
    @@ -2145,7 +2145,7 @@

    WeaponKillsFusionRifle

    WeaponKillsFusionRifle: = "WeaponKillsFusionRifle"
    @@ -2155,7 +2155,7 @@

    WeaponKillsGrenade

    WeaponKillsGrenade: = "WeaponKillsGrenade"
    @@ -2165,7 +2165,7 @@

    WeaponKillsHandCannon

    WeaponKillsHandCannon: = "WeaponKillsHandCannon"
    @@ -2175,7 +2175,7 @@

    WeaponKillsMachinegun

    WeaponKillsMachinegun: = "WeaponKillsMachinegun"
    @@ -2185,7 +2185,7 @@

    WeaponKillsMelee

    WeaponKillsMelee: = "WeaponKillsMelee"
    @@ -2195,7 +2195,7 @@

    WeaponKillsPrecisionKillsAutoRifle

    WeaponKillsPrecisionKillsAutoRifle: = "WeaponKillsPrecisionKillsAutoRifle"
    @@ -2205,7 +2205,7 @@

    WeaponKillsPrecisionKillsFusionRifle

    WeaponKillsPrecisionKillsFusionRifle: = "WeaponKillsPrecisionKillsFusionRifle"
    @@ -2215,7 +2215,7 @@

    WeaponKillsPrecisionKillsGrenade

    WeaponKillsPrecisionKillsGrenade: = "WeaponKillsPrecisionKillsGrenade"
    @@ -2225,7 +2225,7 @@

    WeaponKillsPrecisionKillsHandCannon

    WeaponKillsPrecisionKillsHandCannon: = "WeaponKillsPrecisionKillsHandCannon"
    @@ -2235,7 +2235,7 @@

    WeaponKillsPrecisionKillsMachinegun

    WeaponKillsPrecisionKillsMachinegun: = "WeaponKillsPrecisionKillsMachinegun"
    @@ -2245,7 +2245,7 @@

    WeaponKillsPrecisionKillsMelee

    WeaponKillsPrecisionKillsMelee: = "WeaponKillsPrecisionKillsMelee"
    @@ -2255,7 +2255,7 @@

    WeaponKillsPrecisionKillsPulseRifle

    WeaponKillsPrecisionKillsPulseRifle: = "WeaponKillsPrecisionKillsPulseRifle"
    @@ -2265,7 +2265,7 @@

    WeaponKillsPrecisionKillsRelic

    WeaponKillsPrecisionKillsRelic: = "WeaponKillsPrecisionKillsRelic"
    @@ -2275,7 +2275,7 @@

    WeaponKillsPrecisionKillsRocketLauncher

    WeaponKillsPrecisionKillsRocketLauncher: = "WeaponKillsPrecisionKillsRocketLauncher"
    @@ -2285,7 +2285,7 @@

    WeaponKillsPrecisionKillsScoutRifle

    WeaponKillsPrecisionKillsScoutRifle: = "WeaponKillsPrecisionKillsScoutRifle"
    @@ -2295,7 +2295,7 @@

    WeaponKillsPrecisionKillsShotgun

    WeaponKillsPrecisionKillsShotgun: = "WeaponKillsPrecisionKillsShotgun"
    @@ -2305,7 +2305,7 @@

    WeaponKillsPrecisionKillsSideArm

    WeaponKillsPrecisionKillsSideArm: = "WeaponKillsPrecisionKillsSideArm"
    @@ -2315,7 +2315,7 @@

    WeaponKillsPrecisionKillsSniper

    WeaponKillsPrecisionKillsSniper: = "WeaponKillsPrecisionKillsSniper"
    @@ -2325,7 +2325,7 @@

    WeaponKillsPrecisionKillsSubmachinegun

    WeaponKillsPrecisionKillsSubmachinegun: = "WeaponKillsPrecisionKillsSubmachinegun"
    @@ -2335,7 +2335,7 @@

    WeaponKillsPrecisionKillsSuper

    WeaponKillsPrecisionKillsSuper: = "WeaponKillsPrecisionKillsSuper"
    @@ -2345,7 +2345,7 @@

    WeaponKillsPulseRifle

    WeaponKillsPulseRifle: = "WeaponKillsPulseRifle"
    @@ -2355,7 +2355,7 @@

    WeaponKillsRelic

    WeaponKillsRelic: = "WeaponKillsRelic"
    @@ -2365,7 +2365,7 @@

    WeaponKillsRocketLauncher

    WeaponKillsRocketLauncher: = "WeaponKillsRocketLauncher"
    @@ -2375,7 +2375,7 @@

    WeaponKillsScoutRifle

    WeaponKillsScoutRifle: = "WeaponKillsScoutRifle"
    @@ -2385,7 +2385,7 @@

    WeaponKillsShotgun

    WeaponKillsShotgun: = "WeaponKillsShotgun"
    @@ -2395,7 +2395,7 @@

    WeaponKillsSideArm

    WeaponKillsSideArm: = "WeaponKillsSideArm"
    @@ -2405,7 +2405,7 @@

    WeaponKillsSniper

    WeaponKillsSniper: = "WeaponKillsSniper"
    @@ -2415,7 +2415,7 @@

    WeaponKillsSubmachinegun

    WeaponKillsSubmachinegun: = "WeaponKillsSubmachinegun"
    @@ -2425,7 +2425,7 @@

    WeaponKillsSuper

    WeaponKillsSuper: = "WeaponKillsSuper"
    @@ -2435,7 +2435,7 @@

    WeaponKillsSword

    WeaponKillsSword: = "WeaponKillsSword"
    @@ -2445,7 +2445,7 @@

    WeaponPrecisionKillsAutoRifle

    WeaponPrecisionKillsAutoRifle: = "WeaponPrecisionKillsAutoRifle"
    @@ -2455,7 +2455,7 @@

    WeaponPrecisionKillsFusionRifle

    WeaponPrecisionKillsFusionRifle: = "WeaponPrecisionKillsFusionRifle"
    @@ -2465,7 +2465,7 @@

    WeaponPrecisionKillsGrenade

    WeaponPrecisionKillsGrenade: = "WeaponPrecisionKillsGrenade"
    @@ -2475,7 +2475,7 @@

    WeaponPrecisionKillsHandCannon

    WeaponPrecisionKillsHandCannon: = "WeaponPrecisionKillsHandCannon"
    @@ -2485,7 +2485,7 @@

    WeaponPrecisionKillsMachinegun

    WeaponPrecisionKillsMachinegun: = "WeaponPrecisionKillsMachinegun"
    @@ -2495,7 +2495,7 @@

    WeaponPrecisionKillsMelee

    WeaponPrecisionKillsMelee: = "WeaponPrecisionKillsMelee"
    @@ -2505,7 +2505,7 @@

    WeaponPrecisionKillsPulseRifle

    WeaponPrecisionKillsPulseRifle: = "WeaponPrecisionKillsPulseRifle"
    @@ -2515,7 +2515,7 @@

    WeaponPrecisionKillsRelic

    WeaponPrecisionKillsRelic: = "WeaponPrecisionKillsRelic"
    @@ -2525,7 +2525,7 @@

    WeaponPrecisionKillsRocketLauncher

    WeaponPrecisionKillsRocketLauncher: = "WeaponPrecisionKillsRocketLauncher"
    @@ -2535,7 +2535,7 @@

    WeaponPrecisionKillsScoutRifle

    WeaponPrecisionKillsScoutRifle: = "WeaponPrecisionKillsScoutRifle"
    @@ -2545,7 +2545,7 @@

    WeaponPrecisionKillsShotgun

    WeaponPrecisionKillsShotgun: = "WeaponPrecisionKillsShotgun"
    @@ -2555,7 +2555,7 @@

    WeaponPrecisionKillsSideArm

    WeaponPrecisionKillsSideArm: = "WeaponPrecisionKillsSideArm"
    @@ -2565,7 +2565,7 @@

    WeaponPrecisionKillsSniper

    WeaponPrecisionKillsSniper: = "WeaponPrecisionKillsSniper"
    @@ -2575,7 +2575,7 @@

    WeaponPrecisionKillsSubmachinegun

    WeaponPrecisionKillsSubmachinegun: = "WeaponPrecisionKillsSubmachinegun"
    @@ -2585,7 +2585,7 @@

    WeaponPrecisionKillsSuper

    WeaponPrecisionKillsSuper: = "WeaponPrecisionKillsSuper"
    @@ -2595,7 +2595,7 @@

    WinLossRatio

    WinLossRatio: = "WinLossRatio"
    diff --git a/docs/enums/tiertype.html b/docs/enums/tiertype.html index d368158..8c5cd51 100644 --- a/docs/enums/tiertype.html +++ b/docs/enums/tiertype.html @@ -93,7 +93,7 @@

    Basic

    Basic: = 2
    @@ -103,7 +103,7 @@

    Common

    Common: = 3
    @@ -113,7 +113,7 @@

    Currency

    Currency: = 1
    @@ -123,7 +123,7 @@

    Exotic

    Exotic: = 6
    @@ -133,7 +133,7 @@

    Rare

    Rare: = 4
    @@ -143,7 +143,7 @@

    Superior

    Superior: = 5
    @@ -153,7 +153,7 @@

    Unknown

    Unknown: = 0
    diff --git a/docs/enums/transferstatuses.html b/docs/enums/transferstatuses.html index e83f584..e1e8cfd 100644 --- a/docs/enums/transferstatuses.html +++ b/docs/enums/transferstatuses.html @@ -66,6 +66,15 @@

    Enumeration TransferStatuses

    +
    +
    +
    +

    Whether you can transfer an item, and why not if you can't.

    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +

    Index

    @@ -90,7 +99,7 @@

    CanTransfer

    CanTransfer: = 0
    @@ -105,7 +114,7 @@

    ItemIsEquipped

    ItemIsEquipped: = 1
    @@ -120,7 +129,7 @@

    NoRoomInDestination

    NoRoomInDestination: = 4
    @@ -136,7 +145,7 @@

    NotTransferrable

    NotTransferrable: = 2
    diff --git a/docs/enums/trendingentrytype.html b/docs/enums/trendingentrytype.html index a9bdfb3..3d98bab 100644 --- a/docs/enums/trendingentrytype.html +++ b/docs/enums/trendingentrytype.html @@ -66,6 +66,13 @@

    Enumeration TrendingEntryType

    +
    +
    +
    +

    The known entity types that you can have returned from Trending.

    +
    +
    +

    Index

    @@ -98,7 +105,7 @@

    Container

    Container: = 10
    @@ -108,7 +115,7 @@

    Creation

    Creation: = 5
    @@ -118,7 +125,7 @@

    DestinyActivity

    DestinyActivity: = 2
    @@ -128,7 +135,7 @@

    DestinyItem

    DestinyItem: = 1
    @@ -138,7 +145,7 @@

    DestinyRitual

    DestinyRitual: = 3
    @@ -148,7 +155,7 @@

    ForumTag

    ForumTag: = 9
    @@ -158,7 +165,7 @@

    Link

    Link: = 8
    @@ -168,7 +175,7 @@

    News

    News: = 0
    @@ -178,7 +185,7 @@

    Release

    Release: = 11
    @@ -188,7 +195,7 @@

    Stream

    Stream: = 6
    @@ -198,7 +205,7 @@

    SupportArticle

    SupportArticle: = 4
    @@ -208,7 +215,7 @@

    Update

    Update: = 7
    diff --git a/docs/enums/typedefinition.html b/docs/enums/typedefinition.html index 057ad80..ee51696 100644 --- a/docs/enums/typedefinition.html +++ b/docs/enums/typedefinition.html @@ -122,7 +122,7 @@

    DestinyActivityGraphDefinition

    DestinyActivityGraphDefinition: = "DestinyActivityGraphDefinition"
    @@ -132,7 +132,7 @@

    DestinyActivityModeDefinition

    DestinyActivityModeDefinition: = "DestinyActivityModeDefinition"
    @@ -142,7 +142,7 @@

    DestinyActivityModifierDefinition

    DestinyActivityModifierDefinition: = "DestinyActivityModifierDefinition"
    @@ -152,7 +152,7 @@

    DestinyActivityTypeDefinition

    DestinyActivityTypeDefinition: = "DestinyActivityTypeDefinition"
    @@ -162,7 +162,7 @@

    DestinyBondDefinition

    DestinyBondDefinition: = "DestinyBondDefinition"
    @@ -172,7 +172,7 @@

    DestinyClassDefinition

    DestinyClassDefinition: = "DestinyClassDefinition"
    @@ -182,7 +182,7 @@

    DestinyDamageTypeDefinition

    DestinyDamageTypeDefinition: = "DestinyDamageTypeDefinition"
    @@ -192,7 +192,7 @@

    DestinyDestinationDefinition

    DestinyDestinationDefinition: = "DestinyDestinationDefinition"
    @@ -202,7 +202,7 @@

    DestinyEnemyRaceDefinition

    DestinyEnemyRaceDefinition: = "DestinyEnemyRaceDefinition"
    @@ -212,7 +212,7 @@

    DestinyFactionDefinition

    DestinyFactionDefinition: = "DestinyFactionDefinition"
    @@ -222,7 +222,7 @@

    DestinyGenderDefinition

    DestinyGenderDefinition: = "DestinyGenderDefinition"
    @@ -232,7 +232,7 @@

    DestinyHistoricalStatsDefinition

    DestinyHistoricalStatsDefinition: = "DestinyHistoricalStatsDefinition"
    @@ -242,7 +242,7 @@

    DestinyInventoryBucketDefinition

    DestinyInventoryBucketDefinition: = "DestinyInventoryBucketDefinition"
    @@ -252,7 +252,7 @@

    DestinyInventoryItemDefinition

    DestinyInventoryItemDefinition: = "DestinyInventoryItemDefinition"
    @@ -262,7 +262,7 @@

    DestinyItemCategoryDefinition

    DestinyItemCategoryDefinition: = "DestinyItemCategoryDefinition"
    @@ -272,7 +272,7 @@

    DestinyItemTierTypeDefinition

    DestinyItemTierTypeDefinition: = "DestinyItemTierTypeDefinition"
    @@ -282,7 +282,7 @@

    DestinyLocationDefinition

    DestinyLocationDefinition: = "DestinyLocationDefinition"
    @@ -292,7 +292,7 @@

    DestinyLoreDefinition

    DestinyLoreDefinition: = "DestinyLoreDefinition"
    @@ -302,7 +302,7 @@

    DestinyMedalTierDefinition

    DestinyMedalTierDefinition: = "DestinyMedalTierDefinition"
    @@ -312,7 +312,7 @@

    DestinyMilestoneDefinition

    DestinyMilestoneDefinition: = "DestinyMilestoneDefinition"
    @@ -322,7 +322,7 @@

    DestinyObjectiveDefinition

    DestinyObjectiveDefinition: = "DestinyObjectiveDefinition"
    @@ -332,7 +332,7 @@

    DestinyPlaceDefinition

    DestinyPlaceDefinition: = "DestinyPlaceDefinition"
    @@ -342,7 +342,7 @@

    DestinyProgressionDefinition

    DestinyProgressionDefinition: = "DestinyProgressionDefinition"
    @@ -352,7 +352,7 @@

    DestinyProgressionLevelRequirementDefinition

    DestinyProgressionLevelRequirementDefinition: = "DestinyProgressionLevelRequirementDefinition"
    @@ -362,7 +362,7 @@

    DestinyRaceDefinition

    DestinyRaceDefinition: = "DestinyRaceDefinition"
    @@ -372,7 +372,7 @@

    DestinyRewardSourceDefinition

    DestinyRewardSourceDefinition: = "DestinyRewardSourceDefinition"
    @@ -382,7 +382,7 @@

    DestinySackRewardItemListDefinition

    DestinySackRewardItemListDefinition: = "DestinySackRewardItemListDefinition"
    @@ -392,7 +392,7 @@

    DestinySandboxPerkDefinition

    DestinySandboxPerkDefinition: = "DestinySandboxPerkDefinition"
    @@ -402,7 +402,7 @@

    DestinySocketCategoryDefinition

    DestinySocketCategoryDefinition: = "DestinySocketCategoryDefinition"
    @@ -412,7 +412,7 @@

    DestinySocketTypeDefinition

    DestinySocketTypeDefinition: = "DestinySocketTypeDefinition"
    @@ -422,7 +422,7 @@

    DestinyStatDefinition

    DestinyStatDefinition: = "DestinyStatDefinition"
    @@ -432,7 +432,7 @@

    DestinyStatGroupDefinition

    DestinyStatGroupDefinition: = "DestinyStatGroupDefinition"
    @@ -442,7 +442,7 @@

    DestinyTalentGridDefinition

    DestinyTalentGridDefinition: = "DestinyTalentGridDefinition"
    @@ -452,7 +452,7 @@

    DestinyUnlockDefinition

    DestinyUnlockDefinition: = "DestinyUnlockDefinition"
    @@ -462,7 +462,7 @@

    DestinyVendorCategoryDefinition

    DestinyVendorCategoryDefinition: = "DestinyVendorCategoryDefinition"
    @@ -472,7 +472,7 @@

    DestinyVendorDefinition

    DestinyVendorDefinition: = "DestinyVendorDefinition"
    diff --git a/docs/enums/unittype.html b/docs/enums/unittype.html index 386f090..d4c14d8 100644 --- a/docs/enums/unittype.html +++ b/docs/enums/unittype.html @@ -100,7 +100,7 @@

    Boolean

    Boolean: = 9
    @@ -115,7 +115,7 @@

    CompletionReason

    CompletionReason: = 13
    @@ -130,7 +130,7 @@

    Count

    Count: = 1
    @@ -145,7 +145,7 @@

    Distance

    Distance: = 6
    @@ -160,7 +160,7 @@

    Milliseconds

    Milliseconds: = 12
    @@ -175,7 +175,7 @@

    None

    None: = 0
    @@ -185,7 +185,7 @@

    PerGame

    PerGame: = 2
    @@ -200,7 +200,7 @@

    Percent

    Percent: = 7
    @@ -215,7 +215,7 @@

    Points

    Points: = 4
    @@ -230,7 +230,7 @@

    Ratio

    Ratio: = 8
    @@ -245,7 +245,7 @@

    Seconds

    Seconds: = 3
    @@ -260,7 +260,7 @@

    Standing

    Standing: = 11
    @@ -275,7 +275,7 @@

    Team

    Team: = 5
    @@ -290,7 +290,7 @@

    WeaponType

    WeaponType: = 10
    diff --git a/docs/enums/vendordisplaycategorysortorder.html b/docs/enums/vendordisplaycategorysortorder.html index 65cc158..cad8084 100644 --- a/docs/enums/vendordisplaycategorysortorder.html +++ b/docs/enums/vendordisplaycategorysortorder.html @@ -66,6 +66,13 @@

    Enumeration VendorDisplayCategorySortOrder

    +
    +
    +
    +

    Display categories can have custom sort orders. These are the possible options.

    +
    +
    +

    Index

    @@ -88,7 +95,7 @@

    Default

    Default: = 0
    @@ -98,7 +105,7 @@

    SortByTier

    SortByTier: = 1
    diff --git a/docs/enums/vendorinteractiontype.html b/docs/enums/vendorinteractiontype.html index 607119a..5a84973 100644 --- a/docs/enums/vendorinteractiontype.html +++ b/docs/enums/vendorinteractiontype.html @@ -66,6 +66,13 @@

    Enumeration VendorInteractionType

    +
    +
    +
    +

    An enumeration of the known UI interactions for Vendors.

    +
    +
    +

    Index

    @@ -96,7 +103,7 @@

    End

    End: = 8
    @@ -111,7 +118,7 @@

    ProgressTab

    ProgressTab: = 7
    @@ -128,7 +135,7 @@

    QuestAccept

    QuestAccept: = 6
    @@ -143,7 +150,7 @@

    QuestComplete

    QuestComplete: = 1
    @@ -158,7 +165,7 @@

    QuestContinue

    QuestContinue: = 2
    @@ -174,7 +181,7 @@

    RankUpReward

    RankUpReward: = 4
    @@ -189,7 +196,7 @@

    ReputationPreview

    ReputationPreview: = 3
    @@ -204,7 +211,7 @@

    Start

    Start: = 9
    @@ -219,7 +226,7 @@

    TokenTurnIn

    TokenTurnIn: = 5
    @@ -234,7 +241,7 @@

    Unknown

    Unknown: = 0
    diff --git a/docs/enums/vendoritemstatus.html b/docs/enums/vendoritemstatus.html index 98bf54f..e4139ea 100644 --- a/docs/enums/vendoritemstatus.html +++ b/docs/enums/vendoritemstatus.html @@ -66,6 +66,14 @@

    Enumeration VendorItemStatus

    +
    +
    +
    +

    This enum represents a set of flags - use bitwise operators to check which of + these match your value.

    +
    +
    +

    Index

    @@ -101,7 +109,7 @@

    AlreadyOwned

    AlreadyOwned: = 4096
    @@ -111,7 +119,7 @@

    AlreadySelling

    AlreadySelling: = 512
    @@ -121,7 +129,7 @@

    DisplayOnly

    DisplayOnly: = 8192
    @@ -131,7 +139,7 @@

    NoFunds

    NoFunds: = 2
    @@ -141,7 +149,7 @@

    NoInventorySpace

    NoInventorySpace: = 1
    @@ -151,7 +159,7 @@

    NoProgression

    NoProgression: = 4
    @@ -161,7 +169,7 @@

    NoQuantity

    NoQuantity: = 16
    @@ -171,7 +179,7 @@

    NoUnlock

    NoUnlock: = 8
    @@ -181,7 +189,7 @@

    NotAvailable

    NotAvailable: = 64
    @@ -191,7 +199,7 @@

    OutsidePurchaseWindow

    OutsidePurchaseWindow: = 32
    @@ -201,7 +209,7 @@

    SellingInhibited

    SellingInhibited: = 2048
    @@ -211,7 +219,7 @@

    Success

    Success: = 0
    @@ -221,7 +229,7 @@

    UniquenessViolation

    UniquenessViolation: = 128
    @@ -231,7 +239,7 @@

    UnknownError

    UnknownError: = 256
    @@ -241,7 +249,7 @@

    Unsellable

    Unsellable: = 1024
    diff --git a/docs/globals.html b/docs/globals.html index 4bfbe35..8de3abe 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -197,7 +197,7 @@

    Classes

  • GlobalResource
  • HTTPService
  • Logger
  • -
  • OAuthError
  • +
  • OAuthError
  • OAuthResource
  • UserResource
  • @@ -205,410 +205,414 @@

    Classes

    Interfaces

    @@ -620,7 +624,6 @@

    Variables

  • Destiny2
  • Fireteam
  • Forum
  • -
  • GroupV2
  • Trending
  • User
  • @@ -640,90 +643,80 @@

    Variables

    Const App

    -
    App: "/Users/alexanderweiss/Documents/Programming/NodeProjects/the-traveler/src/type-definitions/app/index" = AppImport
    +
    App: "/Users/alexanderweiss/Documents/Programming/typescript-projects/the-traveler/src/type-definitions/app/index" = AppImport

    Const CommunityContent

    -
    CommunityContent: "/Users/alexanderweiss/Documents/Programming/NodeProjects/the-traveler/src/type-definitions/communitycontent/index" = CommunityContentImport
    +
    CommunityContent: "/Users/alexanderweiss/Documents/Programming/typescript-projects/the-traveler/src/type-definitions/communitycontent/index" = CommunityContentImport

    Const Content

    -
    Content: "/Users/alexanderweiss/Documents/Programming/NodeProjects/the-traveler/src/type-definitions/content/index" = ContentImport
    +
    Content: "/Users/alexanderweiss/Documents/Programming/typescript-projects/the-traveler/src/type-definitions/content/index" = ContentImport

    Const Destiny2

    -
    Destiny2: "/Users/alexanderweiss/Documents/Programming/NodeProjects/the-traveler/src/type-definitions/destiny2/index" = Destiny2Import
    +
    Destiny2: "/Users/alexanderweiss/Documents/Programming/typescript-projects/the-traveler/src/type-definitions/destiny2/index" = Destiny2Import

    Const Fireteam

    -
    Fireteam: "/Users/alexanderweiss/Documents/Programming/NodeProjects/the-traveler/src/type-definitions/fireteam/index" = FireteamImport
    +
    Fireteam: "/Users/alexanderweiss/Documents/Programming/typescript-projects/the-traveler/src/type-definitions/fireteam/index" = FireteamImport

    Const Forum

    -
    Forum: "/Users/alexanderweiss/Documents/Programming/NodeProjects/the-traveler/src/type-definitions/forum/index" = ForumImport
    +
    Forum: "/Users/alexanderweiss/Documents/Programming/typescript-projects/the-traveler/src/type-definitions/forum/index" = ForumImport
    -
    -
    - -

    Const GroupV2

    -
    GroupV2: "/Users/alexanderweiss/Documents/Programming/NodeProjects/the-traveler/src/type-definitions/groupv2/index" = GroupV2Import
    -

    Const Trending

    -
    Trending: "/Users/alexanderweiss/Documents/Programming/NodeProjects/the-traveler/src/type-definitions/trending/index" = TrendingImport
    +
    Trending: "/Users/alexanderweiss/Documents/Programming/typescript-projects/the-traveler/src/type-definitions/trending/index" = TrendingImport

    Const User

    -
    User: "/Users/alexanderweiss/Documents/Programming/NodeProjects/the-traveler/src/type-definitions/user/index" = UserImport
    +
    User: "/Users/alexanderweiss/Documents/Programming/typescript-projects/the-traveler/src/type-definitions/user/index" = UserImport
    @@ -740,7 +733,7 @@

    checkOauthToken

  • @@ -767,13 +760,13 @@

    Returns void

    resolveQueryStringParameters

    • @@ -788,7 +781,7 @@

      resolveQueryStringParameters

      Parameters

      • -
        queryStringParameters: IQueryStringParameters
        +
        queryStringParameters: QueryStringParameters

        Object which contains the query keys and values

        @@ -1177,7 +1170,7 @@

        Returns string Logger

      • -
      • +
      • OAuthError
      • @@ -1187,1216 +1180,1228 @@

        Returns stringUserResource

      • - IApiUsage + ApiUsage
      • - IApplication + Application
      • - IApplicationDeveloper + ApplicationDeveloper
      • - IAwaAuthorizationResult + AwaAuthorizationResult
      • - IAwaInitializeResponse + AwaInitializeResponse
      • - IAwaPermissionRequested + AwaPermissionRequested
      • - IAwaUserResponse + AwaUserResponse
      • - IClanBanner + ClanBanner
      • - ICommentSummary + CommentSummary
      • - ICommunityLiveStatus + CommunityLiveStatus
      • - IContentItemPublicContract + ContentItemPublicContract
      • - IContentPreview + ContentPreview
      • - IContentRepresentation + ContentRepresentation
      • - IContentTypeDefaultValue + ContentTypeDefaultValue
      • - IContentTypeDescription + ContentTypeDescription
      • - IContentTypeProperty + ContentTypeProperty
      • - IContentTypePropertySection + ContentTypePropertySection
      • - IDatapoint + Datapoint
      • - IDateRange + DateRange
      • - IDestinyActivity + DestinyActivity
      • - IDestinyActivityChallengeDefinition + DestinyActivityChallengeDefinition
      • - IDestinyActivityDefinition + DestinyActivityDefinition
      • - IDestinyActivityGraphArtElementDefinition + DestinyActivityGraphArtElementDefinition
      • - IDestinyActivityGraphConnectionDefinition + DestinyActivityGraphConnectionDefinition
      • - IDestinyActivityGraphDefinition + DestinyActivityGraphDefinition
      • - IDestinyActivityGraphDisplayObjectiveDefinition + DestinyActivityGraphDisplayObjectiveDefinition
      • - IDestinyActivityGraphDisplayProgressionDefinition + DestinyActivityGraphDisplayProgressionDefinition
      • - IDestinyActivityGraphListEntryDefinition + DestinyActivityGraphListEntryDefinition
      • - IDestinyActivityGraphNodeActivityDefinition + DestinyActivityGraphNodeActivityDefinition
      • - IDestinyActivityGraphNodeDefinition + DestinyActivityGraphNodeDefinition
      • - IDestinyActivityGraphNodeFeaturingStateDefinition + DestinyActivityGraphNodeFeaturingStateDefinition
      • - IDestinyActivityGraphNodeStateEntry + DestinyActivityGraphNodeStateEntry
      • - IDestinyActivityGuidedBlockDefinition + DestinyActivityGuidedBlockDefinition
      • - IDestinyActivityHistoryResults + DestinyActivityHistoryResults
      • - IDestinyActivityInsertionPointDefinition + DestinyActivityInsertionPointDefinition
      • - IDestinyActivityLoadoutRequirement + DestinyActivityLoadoutRequirement
      • - IDestinyActivityLoadoutRequirementSet + DestinyActivityLoadoutRequirementSet
      • - IDestinyActivityMatchmakingBlockDefinition + DestinyActivityMatchmakingBlockDefinition
      • - IDestinyActivityModeDefinition + DestinyActivityModeDefinition
      • - IDestinyActivityModifierDefinition + DestinyActivityModifierDefinition
      • - IDestinyActivityModifierReferenceDefinition + DestinyActivityModifierReferenceDefinition
      • - IDestinyActivityPlaylistItemDefinition + DestinyActivityPlaylistItemDefinition
      • - IDestinyActivityRewardDefinition + DestinyActivityRewardDefinition
      • - IDestinyActivityTypeDefinition + DestinyActivityTypeDefinition
      • - IDestinyActivityUnlockStringDefinition + DestinyActivityUnlockStringDefinition
      • - IDestinyAggregateActivityResults + DestinyAggregateActivityResults
      • - IDestinyAggregateActivityStats + DestinyAggregateActivityStats
      • - IDestinyAnimationReference + DestinyAnimationReference
      • - IDestinyArtDyeReference + DestinyArtDyeReference
      • - IDestinyBaseItemComponentSetOfuint32 + DestinyBaseItemComponentSetOfuint32
      • - IDestinyBubbleDefinition + DestinyBubbleDefinition
      • - IDestinyChallengeStatus + DestinyChallengeStatus
      • - IDestinyCharacterActivitiesComponent + DestinyCharacterActivitiesComponent
      • - IDestinyCharacterComponent + DestinyCharacterComponent
      • - IDestinyCharacterCustomization + DestinyCharacterCustomization
      • - IDestinyCharacterPeerView + DestinyCharacterPeerView
      • - IDestinyCharacterProgressionComponent + DestinyCharacterProgressionComponent
      • - IDestinyCharacterRecordsComponent + DestinyCharacterRecordsComponent
      • - IDestinyCharacterRenderComponent + DestinyCharacterRenderComponent
      • - IDestinyCharacterResponse + DestinyCharacterResponse
      • - IDestinyChecklistDefinition + DestinyChecklistDefinition
      • - IDestinyChecklistEntryDefinition + DestinyChecklistEntryDefinition
      • - IDestinyClanAggregateStat + DestinyClanAggregateStat
      • - IDestinyClassDefinition + DestinyClassDefinition
      • - IDestinyCollectibleAcquisitionBlock + DestinyCollectibleAcquisitionBlock
      • - IDestinyCollectibleComponent + DestinyCollectibleComponent
      • - IDestinyCollectibleDefinition + DestinyCollectibleDefinition
      • - IDestinyCollectibleNodeDetailResponse + DestinyCollectibleNodeDetailResponse
      • - IDestinyCollectibleStateBlock + DestinyCollectibleStateBlock
      • - IDestinyCollectiblesComponent + DestinyCollectiblesComponent
      • - IDestinyColor + DestinyColor
      • - IDestinyCurrenciesComponent + DestinyCurrenciesComponent
      • - IDestinyDamageTypeDefinition + DestinyDamageTypeDefinition
      • - IDestinyDefinition + DestinyDefinition
      • - IDestinyDerivedItemCategoryDefinition + DestinyDerivedItemCategoryDefinition
      • - IDestinyDerivedItemDefinition + DestinyDerivedItemDefinition
      • - IDestinyDestinationBubbleSettingDefinition + DestinyDestinationBubbleSettingDefinition
      • - IDestinyDestinationDefinition + DestinyDestinationDefinition
      • - IDestinyDisplayCategoryDefinition + DestinyDisplayCategoryDefinition
      • - IDestinyDisplayPropertiesDefinition + DestinyDisplayPropertiesDefinition
      • - IDestinyEntitySearchResult + DestinyEntitySearchResult
      • - IDestinyEntitySearchResultItem + DestinyEntitySearchResultItem
      • - IDestinyEnvironmentLocationMapping + DestinyEnvironmentLocationMapping
      • - IDestinyEquipItemResult + DestinyEquipItemResult
      • - IDestinyEquipItemResults + DestinyEquipItemResults
      • - IDestinyEquipmentSlotDefinition + DestinyEquipmentSlotDefinition
      • - IDestinyEquippingBlockDefinition + DestinyEquippingBlockDefinition
      • - IDestinyErrorProfile + DestinyErrorProfile
      • - IDestinyFactionDefinition + DestinyFactionDefinition
      • - IDestinyFactionProgression + DestinyFactionProgression
      • - IDestinyFactionVendorDefinition + DestinyFactionVendorDefinition
      • - IDestinyGearArtArrangementReference + DestinyGearArtArrangementReference
      • - IDestinyGenderDefinition + DestinyGenderDefinition
      • - IDestinyHistoricalStatsAccountResult + DestinyHistoricalStatsAccountResult
      • - IDestinyHistoricalStatsActivity + DestinyHistoricalStatsActivity
      • - IDestinyHistoricalStatsByPeriod + DestinyHistoricalStatsByPeriod
      • - IDestinyHistoricalStatsDefinition + DestinyHistoricalStatsDefinition
      • - IDestinyHistoricalStatsPerCharacter + DestinyHistoricalStatsPerCharacter
      • - IDestinyHistoricalStatsPeriodGroup + DestinyHistoricalStatsPeriodGroup
      • - IDestinyHistoricalStatsValue + DestinyHistoricalStatsValue
      • - IDestinyHistoricalStatsValuePair + DestinyHistoricalStatsValuePair
      • - IDestinyHistoricalStatsWithMerged + DestinyHistoricalStatsWithMerged
      • - IDestinyHistoricalWeaponStats + DestinyHistoricalWeaponStats
      • - IDestinyHistoricalWeaponStatsData + DestinyHistoricalWeaponStatsData
      • - IDestinyInsertPlugActionDefinition + DestinyInsertPlugActionDefinition
      • - IDestinyInsertPlugsActionRequest + DestinyInsertPlugsActionRequest
      • - IDestinyInsertPlugsRequestEntry + DestinyInsertPlugsRequestEntry
      • - IDestinyInventoryBucketDefinition + DestinyInventoryBucketDefinition
      • - IDestinyInventoryComponent + DestinyInventoryComponent
      • - IDestinyInventoryItemDefinition + DestinyInventoryItemDefinition
      • - IDestinyInventoryItemStatDefinition + DestinyInventoryItemStatDefinition
      • - IDestinyItemActionBlockDefinition + DestinyItemActionBlockDefinition
      • - IDestinyItemActionRequest + DestinyItemActionRequest
      • - IDestinyItemActionRequiredItemDefinition + DestinyItemActionRequiredItemDefinition
      • - IDestinyItemCategoryDefinition + DestinyItemCategoryDefinition
      • - IDestinyItemChangeResponse + DestinyItemChangeResponse
      • - IDestinyItemComponent + DestinyItemComponent
      • - IDestinyItemComponentSetOfint32 + DestinyItemComponentSetOfint32
      • - IDestinyItemComponentSetOfint64 + DestinyItemComponentSetOfint64
      • - IDestinyItemComponentSetOfuint32 + DestinyItemComponentSetOfuint32
      • - IDestinyItemCreationEntryLevelDefinition + DestinyItemCreationEntryLevelDefinition
      • - IDestinyItemGearsetBlockDefinition + DestinyItemGearsetBlockDefinition
      • - IDestinyItemInstanceComponent + DestinyItemInstanceComponent
      • - IDestinyItemIntrinsicSocketEntryDefinition + DestinyItemIntrinsicSocketEntryDefinition
      • - IDestinyItemInventoryBlockDefinition + DestinyItemInventoryBlockDefinition
      • - IDestinyItemInvestmentStatDefinition + DestinyItemInvestmentStatDefinition
      • - IDestinyItemObjectiveBlockDefinition + DestinyItemObjectiveBlockDefinition
      • - IDestinyItemObjectivesComponent + DestinyItemObjectivesComponent
      • - IDestinyItemPeerView + DestinyItemPeerView
      • - IDestinyItemPerkEntryDefinition + DestinyItemPerkEntryDefinition
      • - IDestinyItemPerksComponent + DestinyItemPerksComponent
      • - IDestinyItemPlug + DestinyItemPlug
      • - IDestinyItemPlugComponent + DestinyItemPlugComponent
      • - IDestinyItemPlugDefinition + DestinyItemPlugDefinition
      • - IDestinyItemPreviewBlockDefinition + DestinyItemPreviewBlockDefinition
      • - IDestinyItemQualityBlockDefinition + DestinyItemQualityBlockDefinition
      • - IDestinyItemQuantity + DestinyItemQuantity
      • - IDestinyItemRenderComponent + DestinyItemRenderComponent
      • - IDestinyItemResponse + DestinyItemResponse
      • - IDestinyItemSackBlockDefinition + DestinyItemSackBlockDefinition
      • - IDestinyItemSetActionRequest + DestinyItemSetActionRequest
      • - IDestinyItemSetBlockDefinition + DestinyItemSetBlockDefinition
      • - IDestinyItemSetBlockEntryDefinition + DestinyItemSetBlockEntryDefinition
      • - IDestinyItemSocketBlockDefinition + DestinyItemSocketBlockDefinition
      • - IDestinyItemSocketCategoryDefinition + DestinyItemSocketCategoryDefinition
      • - IDestinyItemSocketEntryDefinition + DestinyItemSocketEntryDefinition
      • - IDestinyItemSocketEntryPlugItemDefinition + DestinyItemSocketEntryPlugItemDefinition
      • - IDestinyItemSocketEntryPlugItemRandomizedDefinition + DestinyItemSocketEntryPlugItemRandomizedDefinition
      • - IDestinyItemSocketState + DestinyItemSocketState
      • - IDestinyItemSocketsComponent + DestinyItemSocketsComponent
      • - IDestinyItemSourceBlockDefinition + DestinyItemSourceBlockDefinition
      • - IDestinyItemSourceDefinition + DestinyItemSourceDefinition
      • - IDestinyItemStatBlockDefinition + DestinyItemStatBlockDefinition
      • - IDestinyItemStateRequest + DestinyItemStateRequest
      • - IDestinyItemStatsComponent + DestinyItemStatsComponent
      • - IDestinyItemSummaryBlockDefinition + DestinyItemSummaryBlockDefinition
      • - IDestinyItemTalentGridBlockDefinition + DestinyItemTalentGridBlockDefinition
      • - IDestinyItemTalentGridComponent + DestinyItemTalentGridComponent
      • - IDestinyItemTierTypeDefinition + DestinyItemTierTypeDefinition
      • - IDestinyItemTierTypeInfusionBlock + DestinyItemTierTypeInfusionBlock
      • - IDestinyItemTransferRequest + DestinyItemTransferRequest
      • - IDestinyItemTranslationBlockDefinition + DestinyItemTranslationBlockDefinition
      • - IDestinyItemValueBlockDefinition + DestinyItemValueBlockDefinition
      • - IDestinyKioskItem + DestinyItemVendorSourceReference
      • - IDestinyKiosksComponent + DestinyKioskItem
      • - IDestinyLeaderboard + DestinyKiosksComponent
      • - IDestinyLeaderboardEntry + DestinyLeaderboard
      • - IDestinyLinkedGraphDefinition + DestinyLeaderboardEntry
      • - IDestinyLinkedGraphEntryDefinition + DestinyLinkedGraphDefinition
      • - IDestinyLinkedProfilesResponse + DestinyLinkedGraphEntryDefinition
      • - IDestinyLocationDefinition + DestinyLinkedProfilesResponse
      • - IDestinyLocationReleaseDefinition + DestinyLocationDefinition
      • - IDestinyLoreDefinition + DestinyLocationReleaseDefinition
      • - IDestinyManifest + DestinyLoreDefinition
      • - IDestinyMaterialRequirement + DestinyManifest
      • - IDestinyMaterialRequirementSetDefinition + DestinyMaterialRequirement
      • - IDestinyMilestone + DestinyMaterialRequirementSetDefinition
      • - IDestinyMilestoneActivity + DestinyMilestone
      • - IDestinyMilestoneActivityCompletionStatus + DestinyMilestoneActivity
      • - IDestinyMilestoneActivityDefinition + DestinyMilestoneActivityCompletionStatus
      • - IDestinyMilestoneActivityPhase + DestinyMilestoneActivityDefinition
      • - IDestinyMilestoneActivityVariant + DestinyMilestoneActivityPhase
      • - IDestinyMilestoneActivityVariantDefinition + DestinyMilestoneActivityVariant
      • - IDestinyMilestoneChallengeActivity + DestinyMilestoneActivityVariantDefinition
      • - IDestinyMilestoneChallengeActivityDefinition + DestinyMilestoneChallengeActivity
      • - IDestinyMilestoneChallengeActivityGraphNodeEntry + DestinyMilestoneChallengeActivityDefinition
      • - IDestinyMilestoneChallengeActivityPhase + DestinyMilestoneChallengeActivityGraphNodeEntry
      • - IDestinyMilestoneChallengeDefinition + DestinyMilestoneChallengeActivityPhase
      • - IDestinyMilestoneContent + DestinyMilestoneChallengeDefinition
      • - IDestinyMilestoneContentItemCategory + DestinyMilestoneContent
      • - IDestinyMilestoneDefinition + DestinyMilestoneContentItemCategory
      • - IDestinyMilestoneQuest + DestinyMilestoneDefinition
      • - IDestinyMilestoneQuestDefinition + DestinyMilestoneQuest
      • - IDestinyMilestoneQuestRewardItem + DestinyMilestoneQuestDefinition
      • - IDestinyMilestoneQuestRewardsDefinition + DestinyMilestoneQuestRewardItem
      • - IDestinyMilestoneRewardCategory + DestinyMilestoneQuestRewardsDefinition
      • - IDestinyMilestoneRewardCategoryDefinition + DestinyMilestoneRewardCategory
      • - IDestinyMilestoneRewardEntry + DestinyMilestoneRewardCategoryDefinition
      • - IDestinyMilestoneRewardEntryDefinition + DestinyMilestoneRewardEntry
      • - IDestinyMilestoneValueDefinition + DestinyMilestoneRewardEntryDefinition
      • - IDestinyMilestoneVendor + DestinyMilestoneValueDefinition
      • - IDestinyMilestoneVendorDefinition + DestinyMilestoneVendor
      • - IDestinyNodeActivationRequirement + DestinyMilestoneVendorDefinition
      • - IDestinyNodeSocketReplaceResponse + DestinyNodeActivationRequirement
      • - IDestinyNodeStepDefinition + DestinyNodeSocketReplaceResponse
      • - IDestinyObjectiveDefinition + DestinyNodeStepDefinition
      • - IDestinyObjectiveDisplayProperties + DestinyObjectiveDefinition
      • - IDestinyObjectivePerkEntryDefinition + DestinyObjectiveDisplayProperties
      • - IDestinyObjectiveProgress + DestinyObjectivePerkEntryDefinition
      • - IDestinyObjectiveStatEntryDefinition + DestinyObjectiveProgress
      • - IDestinyParentItemOverride + DestinyObjectiveStatEntryDefinition
      • - IDestinyPerkReference + DestinyParentItemOverride
      • - IDestinyPlaceDefinition + DestinyPerkReference
      • - IDestinyPlayer + DestinyPlaceDefinition
      • - IDestinyPlugRuleDefinition + DestinyPlayer
      • - IDestinyPlugSetDefinition + DestinyPlugRuleDefinition
      • - IDestinyPlugSetsComponent + DestinyPlugSetDefinition
      • - IDestinyPlugWhitelistEntryDefinition + DestinyPlugSetsComponent
      • - IDestinyPositionDefinition + DestinyPlugWhitelistEntryDefinition
      • - IDestinyPostGameCarnageReportData + DestinyPositionDefinition
      • - IDestinyPostGameCarnageReportEntry + DestinyPostGameCarnageReportData
      • - IDestinyPostGameCarnageReportExtendedData + DestinyPostGameCarnageReportEntry
      • - IDestinyPostGameCarnageReportTeamEntry + DestinyPostGameCarnageReportExtendedData
      • - IDestinyPostmasterTransferRequest + DestinyPostGameCarnageReportTeamEntry
      • - IDestinyPresentationChildBlock + DestinyPostmasterTransferRequest
      • - IDestinyPresentationNodeChildEntry + DestinyPresentationChildBlock
      • - IDestinyPresentationNodeChildrenBlock + DestinyPresentationNodeChildEntry
      • - IDestinyPresentationNodeCollectibleChildEntry + DestinyPresentationNodeChildrenBlock
      • - IDestinyPresentationNodeComponent + DestinyPresentationNodeCollectibleChildEntry
      • - IDestinyPresentationNodeDefinition + DestinyPresentationNodeComponent
      • - IDestinyPresentationNodeRecordChildEntry + DestinyPresentationNodeDefinition
      • - IDestinyPresentationNodeRequirementsBlock + DestinyPresentationNodeRecordChildEntry
      • - IDestinyPresentationNodesComponent + DestinyPresentationNodeRequirementsBlock
      • - IDestinyProfileCollectiblesComponent + DestinyPresentationNodesComponent
      • - IDestinyProfileComponent + DestinyProfileCollectiblesComponent
      • - IDestinyProfileProgressionComponent + DestinyProfileComponent
      • - IDestinyProfileRecordsComponent + DestinyProfileProgressionComponent
      • - IDestinyProfileResponse + DestinyProfileRecordsComponent
      • - IDestinyProfileUserInfoCard + DestinyProfileResponse
      • - IDestinyProgression + DestinyProfileUserInfoCard
      • - IDestinyProgressionDefinition + DestinyProgression
      • - IDestinyProgressionDisplayPropertiesDefinition + DestinyProgressionDefinition
      • - IDestinyProgressionLevelRequirementDefinition + DestinyProgressionDisplayPropertiesDefinition
      • - IDestinyProgressionMappingDefinition + DestinyProgressionLevelRequirementDefinition
      • - IDestinyProgressionRewardDefinition + DestinyProgressionMappingDefinition
      • - IDestinyProgressionStepDefinition + DestinyProgressionRewardDefinition
      • - IDestinyPublicActivityStatus + DestinyProgressionStepDefinition
      • - IDestinyPublicMilestone + DestinyPublicActivityStatus
      • - IDestinyPublicMilestoneActivity + DestinyPublicMilestone
      • - IDestinyPublicMilestoneActivityVariant + DestinyPublicMilestoneActivity
      • - IDestinyPublicMilestoneChallenge + DestinyPublicMilestoneActivityVariant
      • - IDestinyPublicMilestoneChallengeActivity + DestinyPublicMilestoneChallenge
      • - IDestinyPublicMilestoneQuest + DestinyPublicMilestoneChallengeActivity
      • - IDestinyPublicMilestoneVendor + DestinyPublicMilestoneQuest
      • - IDestinyQuestStatus + DestinyPublicMilestoneVendor
      • - IDestinyRaceDefinition + DestinyPublicVendorComponent
      • - IDestinyRecordCompletionBlock + DestinyPublicVendorSaleItemComponent
      • - IDestinyRecordComponent + DestinyPublicVendorsResponse
      • - IDestinyRecordDefinition + DestinyQuestStatus
      • - IDestinyRecordTitleBlock + DestinyRaceDefinition
      • - IDestinyReportOffensePgcrRequest + DestinyRecordCompletionBlock
      • - IDestinyReportReasonCategoryDefinition + DestinyRecordComponent
      • - IDestinyReportReasonDefinition + DestinyRecordDefinition
      • - IDestinyRewardSourceDefinition + DestinyRecordExpirationBlock
      • - IDestinySandboxPerkDefinition + DestinyRecordTitleBlock
      • - IDestinySocketCategoryDefinition + DestinyReportOffensePgcrRequest
      • - IDestinySocketTypeDefinition + DestinyReportReasonCategoryDefinition
      • - IDestinySocketTypeScalarMaterialRequirementEntry + DestinyReportReasonDefinition
      • - IDestinyStat + DestinyRewardSourceDefinition
      • - IDestinyStatDefinition + DestinySandboxPerkDefinition
      • - IDestinyStatDisplayDefinition + DestinySocketCategoryDefinition
      • - IDestinyStatGroupDefinition + DestinySocketTypeDefinition
      • - IDestinyStatOverrideDefinition + DestinySocketTypeScalarMaterialRequirementEntry
      • - IDestinyTalentExclusiveGroup + DestinyStat
      • - IDestinyTalentGridDefinition + DestinyStatDefinition
      • - IDestinyTalentNode + DestinyStatDisplayDefinition
      • - IDestinyTalentNodeCategory + DestinyStatGroupDefinition
      • - IDestinyTalentNodeDefinition + DestinyStatOverrideDefinition
      • - IDestinyTalentNodeExclusiveSetDefinition + DestinyTalentExclusiveGroup
      • - IDestinyTalentNodeStatBlock + DestinyTalentGridDefinition
      • - IDestinyTalentNodeStepGroups + DestinyTalentNode
      • - IDestinyUnlockDefinition + DestinyTalentNodeCategory
      • - IDestinyUnlockExpressionDefinition + DestinyTalentNodeDefinition
      • - IDestinyUnlockStatus + DestinyTalentNodeExclusiveSetDefinition
      • - IDestinyUnlockValueDefinition + DestinyTalentNodeStatBlock
      • - IDestinyVendorAcceptedItemDefinition + DestinyTalentNodeStepGroups
      • - IDestinyVendorActionDefinition + DestinyUnlockDefinition
      • - IDestinyVendorCategoriesComponent + DestinyUnlockExpressionDefinition
      • - IDestinyVendorCategory + DestinyUnlockStatus
      • - IDestinyVendorCategoryEntryDefinition + DestinyUnlockValueDefinition
      • - IDestinyVendorCategoryOverlayDefinition + DestinyVendorAcceptedItemDefinition
      • - IDestinyVendorComponent + DestinyVendorActionDefinition
      • - IDestinyVendorDefinition + DestinyVendorCategoriesComponent
      • - IDestinyVendorDisplayPropertiesDefinition + DestinyVendorCategory
      • - IDestinyVendorGroup + DestinyVendorCategoryEntryDefinition
      • - IDestinyVendorGroupComponent + DestinyVendorCategoryOverlayDefinition
      • - IDestinyVendorGroupDefinition + DestinyVendorComponent
      • - IDestinyVendorGroupReference + DestinyVendorDefinition
      • - IDestinyVendorInteractionDefinition + DestinyVendorDisplayPropertiesDefinition
      • - IDestinyVendorInteractionReplyDefinition + DestinyVendorGroup
      • - IDestinyVendorInteractionSackEntryDefinition + DestinyVendorGroupComponent
      • - IDestinyVendorInventoryFlyoutBucketDefinition + DestinyVendorGroupDefinition
      • - IDestinyVendorInventoryFlyoutDefinition + DestinyVendorGroupReference
      • - IDestinyVendorItemDefinition + DestinyVendorInteractionDefinition
      • - IDestinyVendorItemQuantity + DestinyVendorInteractionReplyDefinition
      • - IDestinyVendorItemSocketOverride + DestinyVendorInteractionSackEntryDefinition
      • - IDestinyVendorLocationDefinition + DestinyVendorInventoryFlyoutBucketDefinition
      • - IDestinyVendorReceipt + DestinyVendorInventoryFlyoutDefinition
      • - IDestinyVendorReceiptsComponent + DestinyVendorItemDefinition
      • - IDestinyVendorRequirementDisplayEntryDefinition + DestinyVendorItemQuantity
      • - IDestinyVendorResponse + DestinyVendorItemSocketOverride
      • - IDestinyVendorSaleItemActionBlockDefinition + DestinyVendorLocationDefinition
      • - IDestinyVendorSaleItemComponent + DestinyVendorReceipt
      • - IDestinyVendorSaleItemSetComponent + DestinyVendorReceiptsComponent
      • - IDestinyVendorServiceDefinition + DestinyVendorRequirementDisplayEntryDefinition
      • - IDestinyVendorsResponse -
      • -
      • - IDictionaryComponentResponse + DestinyVendorResponse
      • -
      • - IDictionaryResponse +
      • + DestinyVendorSaleItemActionBlockDefinition
      • - IDyeReference + DestinyVendorSaleItemComponent
      • - IEntityActionResult + DestinyVendorServiceDefinition
      • - IFireteamMember + DestinyVendorsResponse +
      • +
      • + DictionaryComponentResponse +
      • +
      • + DictionaryResponse
      • - IFireteamResponse + DyeReference
      • - IFireteamSummary + EntityActionResult
      • - IForumRecruitmentDetail + FireteamMember
      • - IGearAssetDataBaseDefinition + FireteamResponse
      • - IGeneralUser + FireteamSummary
      • -
      • - IGlobalAlert +
      • + ForumRecruitmentDetail
      • - IGroupAction + GearAssetDataBaseDefinition
      • - IGroupApplicationListRequest + GeneralUser +
      • +
      • + GlobalAlert
      • - IGroupApplicationRequest + GroupApplicationListRequest
      • - IGroupApplicationResponse + GroupApplicationRequest
      • - IGroupBan + GroupApplicationResponse
      • - IGroupBanRequest + GroupBan
      • - IGroupCreationResponse + GroupBanRequest
      • - IGroupEditAction + GroupEditAction
      • - IGroupFeatures + GroupFeatures
      • - IGroupMember + GroupMember
      • - IGroupMemberApplication + GroupMemberApplication
      • - IGroupMemberLeaveResult + GroupMemberLeaveResult
      • - IGroupMembership + GroupMembership
      • - IGroupMembershipSearchResponse + GroupMembershipSearchResponse
      • - IGroupNameSearchRequest + GroupNameSearchRequest
      • - IGroupOptionalConversation + GroupOptionalConversation
      • - IGroupOptionalConversationAddRequest + GroupOptionalConversationAddRequest
      • - IGroupOptionalConversationEditRequest + GroupOptionalConversationEditRequest
      • - IGroupOptionsEditAction + GroupOptionsEditAction
      • - IGroupPotentialMember + GroupPotentialMember
      • - IGroupPotentialMembership + GroupPotentialMembership
      • - IGroupPotentialMembershipSearchResponse + GroupPotentialMembershipSearchResponse
      • - IGroupQuery + GroupQuery
      • - IGroupResponse + GroupResponse
      • - IGroupSearchResponse + GroupSearchResponse
      • - IGroupTheme + GroupTheme
      • - IGroupV2 + GroupV2
      • - IGroupV2Card + GroupV2Card
      • - IGroupV2ClanInfo + GroupV2ClanInfo
      • - IGroupV2ClanInfoAndInvestment + GroupV2ClanInfoAndInvestment
      • - IHyperlinkReference + HyperlinkReference
      • - IIgnoreResponse + IgnoreResponse +
      • +
      • + ImagePyramidEntry
      • - IInterpolationPoint + InterpolationPoint
      • - IInterpolationPointFloat + InterpolationPointFloat
      • - IOAuthResponse + OAuthResponse
      • - IPagedQuery + PagedQuery
      • - IPollResponse + PersonalDestinyVendorSaleItemSetComponent
      • - IPollResult + PollResponse
      • - IPostResponse + PollResult
      • - IPostSearchResponse + PostResponse
      • - IPublicPartnershipDetail + PostSearchResponse
      • -
      • - IQueryStringParameters +
      • + PublicDestinyVendorSaleItemSetComponent
      • - ISaveMessageResult + PublicPartnershipDetail +
      • +
      • + QueryStringParameters
      • - ISchemaRecordStateBlock + SchemaRecordStateBlock
      • - ISearchResultOfCommunityLiveStatus + SearchResultOfCommunityLiveStatus
      • - ISearchResultOfContentItemPublicContract + SearchResultOfContentItemPublicContract
      • - ISearchResultOfDestinyEntitySearchResultItem + SearchResultOfDestinyEntitySearchResultItem
      • - ISearchResultOfFireteamResponse + SearchResultOfFireteamResponse
      • - ISearchResultOfFireteamSummary + SearchResultOfFireteamSummary
      • - ISearchResultOfGroupBan + SearchResultOfGroupBan
      • - ISearchResultOfGroupMember + SearchResultOfGroupMember
      • - ISearchResultOfGroupMemberApplication + SearchResultOfGroupMemberApplication
      • - ISearchResultOfTrendingEntry + SearchResultOfTrendingEntry
      • - ISeries + Series
      • - IServerResponse + ServerResponse
      • - ISingleComponentResponse + SingleComponentResponse
      • - IStreamInfo + StreamInfo
      • - ITagMetadataDefinition + TagMetadataDefinition
      • - ITagMetadataItem + TagMetadataItem
      • - ITagResponse + TagResponse
      • - ITravelerConfig + TravelerConfig
      • - ITrendingCategories + TrendingCategories
      • - ITrendingCategory + TrendingCategory
      • - ITrendingDetail + TrendingDetail
      • - ITrendingEntry + TrendingEntry
      • - ITrendingEntryCommunityCreation + TrendingEntryCommunityCreation
      • - ITrendingEntryCommunityStream + TrendingEntryCommunityStream
      • - ITrendingEntryDestinyActivity + TrendingEntryDestinyActivity
      • - ITrendingEntryDestinyItem + TrendingEntryDestinyItem
      • - ITrendingEntryDestinyRitual + TrendingEntryDestinyRitual
      • - ITrendingEntryNews + TrendingEntryNews
      • - ITrendingEntrySupportArticle + TrendingEntrySupportArticle
      • - IUserInfoCard + UserInfoCard
      • - IUserMembership + UserMembership
      • - IUserMembershipData + UserMembershipData
      • - IUserTheme + UserTheme
      • - IUserToUserContext + UserToUserContext
      • App @@ -2416,9 +2421,6 @@

        Returns string Forum

      • -
      • - GroupV2 -
      • Trending
      • diff --git a/docs/index.html b/docs/index.html index ee3a675..0f224b6 100644 --- a/docs/index.html +++ b/docs/index.html @@ -260,7 +260,7 @@

        Get a character for an PSN AccountHere all character specific components are queried. You can either use normal strings or use the integrated enums.

        Query:

        import Traveler from 'the-traveler';
        -import {ComponentType} from 'the-traveler/build/enums'
        +import {ComponentType} from 'the-traveler/type-definitions/destiny2';
         
         const traveler = new Traveler({
             apikey: 'pasteYourAPIkey',
        @@ -754,7 +754,7 @@ 

        Acknowledgments

      • Logger
      • -
      • +
      • OAuthError
      • @@ -764,1216 +764,1228 @@

        Acknowledgments

        UserResource
      • - IApiUsage + ApiUsage
      • - IApplication + Application
      • - IApplicationDeveloper + ApplicationDeveloper
      • - IAwaAuthorizationResult + AwaAuthorizationResult
      • - IAwaInitializeResponse + AwaInitializeResponse
      • - IAwaPermissionRequested + AwaPermissionRequested
      • - IAwaUserResponse + AwaUserResponse
      • - IClanBanner + ClanBanner
      • - ICommentSummary + CommentSummary
      • - ICommunityLiveStatus + CommunityLiveStatus
      • - IContentItemPublicContract + ContentItemPublicContract
      • - IContentPreview + ContentPreview
      • - IContentRepresentation + ContentRepresentation
      • - IContentTypeDefaultValue + ContentTypeDefaultValue
      • - IContentTypeDescription + ContentTypeDescription
      • - IContentTypeProperty + ContentTypeProperty
      • - IContentTypePropertySection + ContentTypePropertySection
      • - IDatapoint + Datapoint
      • - IDateRange + DateRange
      • - IDestinyActivity + DestinyActivity
      • - IDestinyActivityChallengeDefinition + DestinyActivityChallengeDefinition
      • - IDestinyActivityDefinition + DestinyActivityDefinition
      • - IDestinyActivityGraphArtElementDefinition + DestinyActivityGraphArtElementDefinition
      • - IDestinyActivityGraphConnectionDefinition + DestinyActivityGraphConnectionDefinition
      • - IDestinyActivityGraphDefinition + DestinyActivityGraphDefinition
      • - IDestinyActivityGraphDisplayObjectiveDefinition + DestinyActivityGraphDisplayObjectiveDefinition
      • - IDestinyActivityGraphDisplayProgressionDefinition + DestinyActivityGraphDisplayProgressionDefinition
      • - IDestinyActivityGraphListEntryDefinition + DestinyActivityGraphListEntryDefinition
      • - IDestinyActivityGraphNodeActivityDefinition + DestinyActivityGraphNodeActivityDefinition
      • - IDestinyActivityGraphNodeDefinition + DestinyActivityGraphNodeDefinition
      • - IDestinyActivityGraphNodeFeaturingStateDefinition + DestinyActivityGraphNodeFeaturingStateDefinition
      • - IDestinyActivityGraphNodeStateEntry + DestinyActivityGraphNodeStateEntry
      • - IDestinyActivityGuidedBlockDefinition + DestinyActivityGuidedBlockDefinition
      • - IDestinyActivityHistoryResults + DestinyActivityHistoryResults
      • - IDestinyActivityInsertionPointDefinition + DestinyActivityInsertionPointDefinition
      • - IDestinyActivityLoadoutRequirement + DestinyActivityLoadoutRequirement
      • - IDestinyActivityLoadoutRequirementSet + DestinyActivityLoadoutRequirementSet
      • - IDestinyActivityMatchmakingBlockDefinition + DestinyActivityMatchmakingBlockDefinition
      • - IDestinyActivityModeDefinition + DestinyActivityModeDefinition
      • - IDestinyActivityModifierDefinition + DestinyActivityModifierDefinition
      • - IDestinyActivityModifierReferenceDefinition + DestinyActivityModifierReferenceDefinition
      • - IDestinyActivityPlaylistItemDefinition + DestinyActivityPlaylistItemDefinition
      • - IDestinyActivityRewardDefinition + DestinyActivityRewardDefinition
      • - IDestinyActivityTypeDefinition + DestinyActivityTypeDefinition
      • - IDestinyActivityUnlockStringDefinition + DestinyActivityUnlockStringDefinition
      • - IDestinyAggregateActivityResults + DestinyAggregateActivityResults
      • - IDestinyAggregateActivityStats + DestinyAggregateActivityStats
      • - IDestinyAnimationReference + DestinyAnimationReference
      • - IDestinyArtDyeReference + DestinyArtDyeReference
      • - IDestinyBaseItemComponentSetOfuint32 + DestinyBaseItemComponentSetOfuint32
      • - IDestinyBubbleDefinition + DestinyBubbleDefinition
      • - IDestinyChallengeStatus + DestinyChallengeStatus
      • - IDestinyCharacterActivitiesComponent + DestinyCharacterActivitiesComponent
      • - IDestinyCharacterComponent + DestinyCharacterComponent
      • - IDestinyCharacterCustomization + DestinyCharacterCustomization
      • - IDestinyCharacterPeerView + DestinyCharacterPeerView
      • - IDestinyCharacterProgressionComponent + DestinyCharacterProgressionComponent
      • - IDestinyCharacterRecordsComponent + DestinyCharacterRecordsComponent
      • - IDestinyCharacterRenderComponent + DestinyCharacterRenderComponent
      • - IDestinyCharacterResponse + DestinyCharacterResponse
      • - IDestinyChecklistDefinition + DestinyChecklistDefinition
      • - IDestinyChecklistEntryDefinition + DestinyChecklistEntryDefinition
      • - IDestinyClanAggregateStat + DestinyClanAggregateStat
      • - IDestinyClassDefinition + DestinyClassDefinition
      • - IDestinyCollectibleAcquisitionBlock + DestinyCollectibleAcquisitionBlock
      • - IDestinyCollectibleComponent + DestinyCollectibleComponent
      • - IDestinyCollectibleDefinition + DestinyCollectibleDefinition
      • - IDestinyCollectibleNodeDetailResponse + DestinyCollectibleNodeDetailResponse
      • - IDestinyCollectibleStateBlock + DestinyCollectibleStateBlock
      • - IDestinyCollectiblesComponent + DestinyCollectiblesComponent
      • - IDestinyColor + DestinyColor
      • - IDestinyCurrenciesComponent + DestinyCurrenciesComponent
      • - IDestinyDamageTypeDefinition + DestinyDamageTypeDefinition
      • - IDestinyDefinition + DestinyDefinition
      • - IDestinyDerivedItemCategoryDefinition + DestinyDerivedItemCategoryDefinition
      • - IDestinyDerivedItemDefinition + DestinyDerivedItemDefinition
      • - IDestinyDestinationBubbleSettingDefinition + DestinyDestinationBubbleSettingDefinition
      • - IDestinyDestinationDefinition + DestinyDestinationDefinition
      • - IDestinyDisplayCategoryDefinition + DestinyDisplayCategoryDefinition
      • - IDestinyDisplayPropertiesDefinition + DestinyDisplayPropertiesDefinition
      • - IDestinyEntitySearchResult + DestinyEntitySearchResult
      • - IDestinyEntitySearchResultItem + DestinyEntitySearchResultItem
      • - IDestinyEnvironmentLocationMapping + DestinyEnvironmentLocationMapping
      • - IDestinyEquipItemResult + DestinyEquipItemResult
      • - IDestinyEquipItemResults + DestinyEquipItemResults
      • - IDestinyEquipmentSlotDefinition + DestinyEquipmentSlotDefinition
      • - IDestinyEquippingBlockDefinition + DestinyEquippingBlockDefinition
      • - IDestinyErrorProfile + DestinyErrorProfile
      • - IDestinyFactionDefinition + DestinyFactionDefinition
      • - IDestinyFactionProgression + DestinyFactionProgression
      • - IDestinyFactionVendorDefinition + DestinyFactionVendorDefinition
      • - IDestinyGearArtArrangementReference + DestinyGearArtArrangementReference
      • - IDestinyGenderDefinition + DestinyGenderDefinition
      • - IDestinyHistoricalStatsAccountResult + DestinyHistoricalStatsAccountResult
      • - IDestinyHistoricalStatsActivity + DestinyHistoricalStatsActivity
      • - IDestinyHistoricalStatsByPeriod + DestinyHistoricalStatsByPeriod
      • - IDestinyHistoricalStatsDefinition + DestinyHistoricalStatsDefinition
      • - IDestinyHistoricalStatsPerCharacter + DestinyHistoricalStatsPerCharacter
      • - IDestinyHistoricalStatsPeriodGroup + DestinyHistoricalStatsPeriodGroup
      • - IDestinyHistoricalStatsValue + DestinyHistoricalStatsValue
      • - IDestinyHistoricalStatsValuePair + DestinyHistoricalStatsValuePair
      • - IDestinyHistoricalStatsWithMerged + DestinyHistoricalStatsWithMerged
      • - IDestinyHistoricalWeaponStats + DestinyHistoricalWeaponStats
      • - IDestinyHistoricalWeaponStatsData + DestinyHistoricalWeaponStatsData
      • - IDestinyInsertPlugActionDefinition + DestinyInsertPlugActionDefinition
      • - IDestinyInsertPlugsActionRequest + DestinyInsertPlugsActionRequest
      • - IDestinyInsertPlugsRequestEntry + DestinyInsertPlugsRequestEntry
      • - IDestinyInventoryBucketDefinition + DestinyInventoryBucketDefinition
      • - IDestinyInventoryComponent + DestinyInventoryComponent
      • - IDestinyInventoryItemDefinition + DestinyInventoryItemDefinition
      • - IDestinyInventoryItemStatDefinition + DestinyInventoryItemStatDefinition
      • - IDestinyItemActionBlockDefinition + DestinyItemActionBlockDefinition
      • - IDestinyItemActionRequest + DestinyItemActionRequest
      • - IDestinyItemActionRequiredItemDefinition + DestinyItemActionRequiredItemDefinition
      • - IDestinyItemCategoryDefinition + DestinyItemCategoryDefinition
      • - IDestinyItemChangeResponse + DestinyItemChangeResponse
      • - IDestinyItemComponent + DestinyItemComponent
      • - IDestinyItemComponentSetOfint32 + DestinyItemComponentSetOfint32
      • - IDestinyItemComponentSetOfint64 + DestinyItemComponentSetOfint64
      • - IDestinyItemComponentSetOfuint32 + DestinyItemComponentSetOfuint32
      • - IDestinyItemCreationEntryLevelDefinition + DestinyItemCreationEntryLevelDefinition
      • - IDestinyItemGearsetBlockDefinition + DestinyItemGearsetBlockDefinition
      • - IDestinyItemInstanceComponent + DestinyItemInstanceComponent
      • - IDestinyItemIntrinsicSocketEntryDefinition + DestinyItemIntrinsicSocketEntryDefinition
      • - IDestinyItemInventoryBlockDefinition + DestinyItemInventoryBlockDefinition
      • - IDestinyItemInvestmentStatDefinition + DestinyItemInvestmentStatDefinition
      • - IDestinyItemObjectiveBlockDefinition + DestinyItemObjectiveBlockDefinition
      • - IDestinyItemObjectivesComponent + DestinyItemObjectivesComponent
      • - IDestinyItemPeerView + DestinyItemPeerView
      • - IDestinyItemPerkEntryDefinition + DestinyItemPerkEntryDefinition
      • - IDestinyItemPerksComponent + DestinyItemPerksComponent
      • - IDestinyItemPlug + DestinyItemPlug
      • - IDestinyItemPlugComponent + DestinyItemPlugComponent
      • - IDestinyItemPlugDefinition + DestinyItemPlugDefinition
      • - IDestinyItemPreviewBlockDefinition + DestinyItemPreviewBlockDefinition
      • - IDestinyItemQualityBlockDefinition + DestinyItemQualityBlockDefinition
      • - IDestinyItemQuantity + DestinyItemQuantity
      • - IDestinyItemRenderComponent + DestinyItemRenderComponent
      • - IDestinyItemResponse + DestinyItemResponse
      • - IDestinyItemSackBlockDefinition + DestinyItemSackBlockDefinition
      • - IDestinyItemSetActionRequest + DestinyItemSetActionRequest
      • - IDestinyItemSetBlockDefinition + DestinyItemSetBlockDefinition
      • - IDestinyItemSetBlockEntryDefinition + DestinyItemSetBlockEntryDefinition
      • - IDestinyItemSocketBlockDefinition + DestinyItemSocketBlockDefinition
      • - IDestinyItemSocketCategoryDefinition + DestinyItemSocketCategoryDefinition
      • - IDestinyItemSocketEntryDefinition + DestinyItemSocketEntryDefinition
      • - IDestinyItemSocketEntryPlugItemDefinition + DestinyItemSocketEntryPlugItemDefinition
      • - IDestinyItemSocketEntryPlugItemRandomizedDefinition + DestinyItemSocketEntryPlugItemRandomizedDefinition
      • - IDestinyItemSocketState + DestinyItemSocketState
      • - IDestinyItemSocketsComponent + DestinyItemSocketsComponent
      • - IDestinyItemSourceBlockDefinition + DestinyItemSourceBlockDefinition
      • - IDestinyItemSourceDefinition + DestinyItemSourceDefinition
      • - IDestinyItemStatBlockDefinition + DestinyItemStatBlockDefinition
      • - IDestinyItemStateRequest + DestinyItemStateRequest
      • - IDestinyItemStatsComponent + DestinyItemStatsComponent
      • - IDestinyItemSummaryBlockDefinition + DestinyItemSummaryBlockDefinition
      • - IDestinyItemTalentGridBlockDefinition + DestinyItemTalentGridBlockDefinition
      • - IDestinyItemTalentGridComponent + DestinyItemTalentGridComponent
      • - IDestinyItemTierTypeDefinition + DestinyItemTierTypeDefinition
      • - IDestinyItemTierTypeInfusionBlock + DestinyItemTierTypeInfusionBlock
      • - IDestinyItemTransferRequest + DestinyItemTransferRequest
      • - IDestinyItemTranslationBlockDefinition + DestinyItemTranslationBlockDefinition
      • - IDestinyItemValueBlockDefinition + DestinyItemValueBlockDefinition
      • - IDestinyKioskItem + DestinyItemVendorSourceReference
      • - IDestinyKiosksComponent + DestinyKioskItem
      • - IDestinyLeaderboard + DestinyKiosksComponent
      • - IDestinyLeaderboardEntry + DestinyLeaderboard
      • - IDestinyLinkedGraphDefinition + DestinyLeaderboardEntry
      • - IDestinyLinkedGraphEntryDefinition + DestinyLinkedGraphDefinition
      • - IDestinyLinkedProfilesResponse + DestinyLinkedGraphEntryDefinition
      • - IDestinyLocationDefinition + DestinyLinkedProfilesResponse
      • - IDestinyLocationReleaseDefinition + DestinyLocationDefinition
      • - IDestinyLoreDefinition + DestinyLocationReleaseDefinition
      • - IDestinyManifest + DestinyLoreDefinition
      • - IDestinyMaterialRequirement + DestinyManifest
      • - IDestinyMaterialRequirementSetDefinition + DestinyMaterialRequirement
      • - IDestinyMilestone + DestinyMaterialRequirementSetDefinition
      • - IDestinyMilestoneActivity + DestinyMilestone
      • - IDestinyMilestoneActivityCompletionStatus + DestinyMilestoneActivity
      • - IDestinyMilestoneActivityDefinition + DestinyMilestoneActivityCompletionStatus
      • - IDestinyMilestoneActivityPhase + DestinyMilestoneActivityDefinition
      • - IDestinyMilestoneActivityVariant + DestinyMilestoneActivityPhase
      • - IDestinyMilestoneActivityVariantDefinition + DestinyMilestoneActivityVariant
      • - IDestinyMilestoneChallengeActivity + DestinyMilestoneActivityVariantDefinition
      • - IDestinyMilestoneChallengeActivityDefinition + DestinyMilestoneChallengeActivity
      • - IDestinyMilestoneChallengeActivityGraphNodeEntry + DestinyMilestoneChallengeActivityDefinition
      • - IDestinyMilestoneChallengeActivityPhase + DestinyMilestoneChallengeActivityGraphNodeEntry
      • - IDestinyMilestoneChallengeDefinition + DestinyMilestoneChallengeActivityPhase
      • - IDestinyMilestoneContent + DestinyMilestoneChallengeDefinition
      • - IDestinyMilestoneContentItemCategory + DestinyMilestoneContent
      • - IDestinyMilestoneDefinition + DestinyMilestoneContentItemCategory
      • - IDestinyMilestoneQuest + DestinyMilestoneDefinition
      • - IDestinyMilestoneQuestDefinition + DestinyMilestoneQuest
      • - IDestinyMilestoneQuestRewardItem + DestinyMilestoneQuestDefinition
      • - IDestinyMilestoneQuestRewardsDefinition + DestinyMilestoneQuestRewardItem
      • - IDestinyMilestoneRewardCategory + DestinyMilestoneQuestRewardsDefinition
      • - IDestinyMilestoneRewardCategoryDefinition + DestinyMilestoneRewardCategory
      • - IDestinyMilestoneRewardEntry + DestinyMilestoneRewardCategoryDefinition
      • - IDestinyMilestoneRewardEntryDefinition + DestinyMilestoneRewardEntry
      • - IDestinyMilestoneValueDefinition + DestinyMilestoneRewardEntryDefinition
      • - IDestinyMilestoneVendor + DestinyMilestoneValueDefinition
      • - IDestinyMilestoneVendorDefinition + DestinyMilestoneVendor
      • - IDestinyNodeActivationRequirement + DestinyMilestoneVendorDefinition
      • - IDestinyNodeSocketReplaceResponse + DestinyNodeActivationRequirement
      • - IDestinyNodeStepDefinition + DestinyNodeSocketReplaceResponse
      • - IDestinyObjectiveDefinition + DestinyNodeStepDefinition
      • - IDestinyObjectiveDisplayProperties + DestinyObjectiveDefinition
      • - IDestinyObjectivePerkEntryDefinition + DestinyObjectiveDisplayProperties
      • - IDestinyObjectiveProgress + DestinyObjectivePerkEntryDefinition
      • - IDestinyObjectiveStatEntryDefinition + DestinyObjectiveProgress
      • - IDestinyParentItemOverride + DestinyObjectiveStatEntryDefinition
      • - IDestinyPerkReference + DestinyParentItemOverride
      • - IDestinyPlaceDefinition + DestinyPerkReference
      • - IDestinyPlayer + DestinyPlaceDefinition
      • - IDestinyPlugRuleDefinition + DestinyPlayer
      • - IDestinyPlugSetDefinition + DestinyPlugRuleDefinition
      • - IDestinyPlugSetsComponent + DestinyPlugSetDefinition
      • - IDestinyPlugWhitelistEntryDefinition + DestinyPlugSetsComponent
      • - IDestinyPositionDefinition + DestinyPlugWhitelistEntryDefinition
      • - IDestinyPostGameCarnageReportData + DestinyPositionDefinition
      • - IDestinyPostGameCarnageReportEntry + DestinyPostGameCarnageReportData
      • - IDestinyPostGameCarnageReportExtendedData + DestinyPostGameCarnageReportEntry
      • - IDestinyPostGameCarnageReportTeamEntry + DestinyPostGameCarnageReportExtendedData
      • - IDestinyPostmasterTransferRequest + DestinyPostGameCarnageReportTeamEntry
      • - IDestinyPresentationChildBlock + DestinyPostmasterTransferRequest
      • - IDestinyPresentationNodeChildEntry + DestinyPresentationChildBlock
      • - IDestinyPresentationNodeChildrenBlock + DestinyPresentationNodeChildEntry
      • - IDestinyPresentationNodeCollectibleChildEntry + DestinyPresentationNodeChildrenBlock
      • - IDestinyPresentationNodeComponent + DestinyPresentationNodeCollectibleChildEntry
      • - IDestinyPresentationNodeDefinition + DestinyPresentationNodeComponent
      • - IDestinyPresentationNodeRecordChildEntry + DestinyPresentationNodeDefinition
      • - IDestinyPresentationNodeRequirementsBlock + DestinyPresentationNodeRecordChildEntry
      • - IDestinyPresentationNodesComponent + DestinyPresentationNodeRequirementsBlock
      • - IDestinyProfileCollectiblesComponent + DestinyPresentationNodesComponent
      • - IDestinyProfileComponent + DestinyProfileCollectiblesComponent
      • - IDestinyProfileProgressionComponent + DestinyProfileComponent
      • - IDestinyProfileRecordsComponent + DestinyProfileProgressionComponent
      • - IDestinyProfileResponse + DestinyProfileRecordsComponent
      • - IDestinyProfileUserInfoCard + DestinyProfileResponse
      • - IDestinyProgression + DestinyProfileUserInfoCard
      • - IDestinyProgressionDefinition + DestinyProgression
      • - IDestinyProgressionDisplayPropertiesDefinition + DestinyProgressionDefinition
      • - IDestinyProgressionLevelRequirementDefinition + DestinyProgressionDisplayPropertiesDefinition
      • - IDestinyProgressionMappingDefinition + DestinyProgressionLevelRequirementDefinition
      • - IDestinyProgressionRewardDefinition + DestinyProgressionMappingDefinition
      • - IDestinyProgressionStepDefinition + DestinyProgressionRewardDefinition
      • - IDestinyPublicActivityStatus + DestinyProgressionStepDefinition
      • - IDestinyPublicMilestone + DestinyPublicActivityStatus
      • - IDestinyPublicMilestoneActivity + DestinyPublicMilestone
      • - IDestinyPublicMilestoneActivityVariant + DestinyPublicMilestoneActivity
      • - IDestinyPublicMilestoneChallenge + DestinyPublicMilestoneActivityVariant
      • - IDestinyPublicMilestoneChallengeActivity + DestinyPublicMilestoneChallenge
      • - IDestinyPublicMilestoneQuest + DestinyPublicMilestoneChallengeActivity
      • - IDestinyPublicMilestoneVendor + DestinyPublicMilestoneQuest
      • - IDestinyQuestStatus + DestinyPublicMilestoneVendor
      • - IDestinyRaceDefinition + DestinyPublicVendorComponent
      • - IDestinyRecordCompletionBlock + DestinyPublicVendorSaleItemComponent
      • - IDestinyRecordComponent + DestinyPublicVendorsResponse
      • - IDestinyRecordDefinition + DestinyQuestStatus
      • - IDestinyRecordTitleBlock + DestinyRaceDefinition
      • - IDestinyReportOffensePgcrRequest + DestinyRecordCompletionBlock
      • - IDestinyReportReasonCategoryDefinition + DestinyRecordComponent
      • - IDestinyReportReasonDefinition + DestinyRecordDefinition
      • - IDestinyRewardSourceDefinition + DestinyRecordExpirationBlock
      • - IDestinySandboxPerkDefinition + DestinyRecordTitleBlock
      • - IDestinySocketCategoryDefinition + DestinyReportOffensePgcrRequest
      • - IDestinySocketTypeDefinition + DestinyReportReasonCategoryDefinition
      • - IDestinySocketTypeScalarMaterialRequirementEntry + DestinyReportReasonDefinition
      • - IDestinyStat + DestinyRewardSourceDefinition
      • - IDestinyStatDefinition + DestinySandboxPerkDefinition
      • - IDestinyStatDisplayDefinition + DestinySocketCategoryDefinition
      • - IDestinyStatGroupDefinition + DestinySocketTypeDefinition
      • - IDestinyStatOverrideDefinition + DestinySocketTypeScalarMaterialRequirementEntry
      • - IDestinyTalentExclusiveGroup + DestinyStat
      • - IDestinyTalentGridDefinition + DestinyStatDefinition
      • - IDestinyTalentNode + DestinyStatDisplayDefinition
      • - IDestinyTalentNodeCategory + DestinyStatGroupDefinition
      • - IDestinyTalentNodeDefinition + DestinyStatOverrideDefinition
      • - IDestinyTalentNodeExclusiveSetDefinition + DestinyTalentExclusiveGroup
      • - IDestinyTalentNodeStatBlock + DestinyTalentGridDefinition
      • - IDestinyTalentNodeStepGroups + DestinyTalentNode
      • - IDestinyUnlockDefinition + DestinyTalentNodeCategory
      • - IDestinyUnlockExpressionDefinition + DestinyTalentNodeDefinition
      • - IDestinyUnlockStatus + DestinyTalentNodeExclusiveSetDefinition
      • - IDestinyUnlockValueDefinition + DestinyTalentNodeStatBlock
      • - IDestinyVendorAcceptedItemDefinition + DestinyTalentNodeStepGroups
      • - IDestinyVendorActionDefinition + DestinyUnlockDefinition
      • - IDestinyVendorCategoriesComponent + DestinyUnlockExpressionDefinition
      • - IDestinyVendorCategory + DestinyUnlockStatus
      • - IDestinyVendorCategoryEntryDefinition + DestinyUnlockValueDefinition
      • - IDestinyVendorCategoryOverlayDefinition + DestinyVendorAcceptedItemDefinition
      • - IDestinyVendorComponent + DestinyVendorActionDefinition
      • - IDestinyVendorDefinition + DestinyVendorCategoriesComponent
      • - IDestinyVendorDisplayPropertiesDefinition + DestinyVendorCategory
      • - IDestinyVendorGroup + DestinyVendorCategoryEntryDefinition
      • - IDestinyVendorGroupComponent + DestinyVendorCategoryOverlayDefinition
      • - IDestinyVendorGroupDefinition + DestinyVendorComponent
      • - IDestinyVendorGroupReference + DestinyVendorDefinition
      • - IDestinyVendorInteractionDefinition + DestinyVendorDisplayPropertiesDefinition
      • - IDestinyVendorInteractionReplyDefinition + DestinyVendorGroup
      • - IDestinyVendorInteractionSackEntryDefinition + DestinyVendorGroupComponent
      • - IDestinyVendorInventoryFlyoutBucketDefinition + DestinyVendorGroupDefinition
      • - IDestinyVendorInventoryFlyoutDefinition + DestinyVendorGroupReference
      • - IDestinyVendorItemDefinition + DestinyVendorInteractionDefinition
      • - IDestinyVendorItemQuantity + DestinyVendorInteractionReplyDefinition
      • - IDestinyVendorItemSocketOverride + DestinyVendorInteractionSackEntryDefinition
      • - IDestinyVendorLocationDefinition + DestinyVendorInventoryFlyoutBucketDefinition
      • - IDestinyVendorReceipt + DestinyVendorInventoryFlyoutDefinition
      • - IDestinyVendorReceiptsComponent + DestinyVendorItemDefinition
      • - IDestinyVendorRequirementDisplayEntryDefinition + DestinyVendorItemQuantity
      • - IDestinyVendorResponse + DestinyVendorItemSocketOverride
      • - IDestinyVendorSaleItemActionBlockDefinition + DestinyVendorLocationDefinition
      • - IDestinyVendorSaleItemComponent + DestinyVendorReceipt
      • - IDestinyVendorSaleItemSetComponent + DestinyVendorReceiptsComponent
      • - IDestinyVendorServiceDefinition + DestinyVendorRequirementDisplayEntryDefinition
      • - IDestinyVendorsResponse -
      • -
      • - IDictionaryComponentResponse + DestinyVendorResponse
      • -
      • - IDictionaryResponse +
      • + DestinyVendorSaleItemActionBlockDefinition
      • - IDyeReference + DestinyVendorSaleItemComponent
      • - IEntityActionResult + DestinyVendorServiceDefinition
      • - IFireteamMember + DestinyVendorsResponse +
      • +
      • + DictionaryComponentResponse +
      • +
      • + DictionaryResponse
      • - IFireteamResponse + DyeReference
      • - IFireteamSummary + EntityActionResult
      • - IForumRecruitmentDetail + FireteamMember
      • - IGearAssetDataBaseDefinition + FireteamResponse
      • - IGeneralUser + FireteamSummary
      • -
      • - IGlobalAlert +
      • + ForumRecruitmentDetail
      • - IGroupAction + GearAssetDataBaseDefinition
      • - IGroupApplicationListRequest + GeneralUser +
      • +
      • + GlobalAlert
      • - IGroupApplicationRequest + GroupApplicationListRequest
      • - IGroupApplicationResponse + GroupApplicationRequest
      • - IGroupBan + GroupApplicationResponse
      • - IGroupBanRequest + GroupBan
      • - IGroupCreationResponse + GroupBanRequest
      • - IGroupEditAction + GroupEditAction
      • - IGroupFeatures + GroupFeatures
      • - IGroupMember + GroupMember
      • - IGroupMemberApplication + GroupMemberApplication
      • - IGroupMemberLeaveResult + GroupMemberLeaveResult
      • - IGroupMembership + GroupMembership
      • - IGroupMembershipSearchResponse + GroupMembershipSearchResponse
      • - IGroupNameSearchRequest + GroupNameSearchRequest
      • - IGroupOptionalConversation + GroupOptionalConversation
      • - IGroupOptionalConversationAddRequest + GroupOptionalConversationAddRequest
      • - IGroupOptionalConversationEditRequest + GroupOptionalConversationEditRequest
      • - IGroupOptionsEditAction + GroupOptionsEditAction
      • - IGroupPotentialMember + GroupPotentialMember
      • - IGroupPotentialMembership + GroupPotentialMembership
      • - IGroupPotentialMembershipSearchResponse + GroupPotentialMembershipSearchResponse
      • - IGroupQuery + GroupQuery
      • - IGroupResponse + GroupResponse
      • - IGroupSearchResponse + GroupSearchResponse
      • - IGroupTheme + GroupTheme
      • - IGroupV2 + GroupV2
      • - IGroupV2Card + GroupV2Card
      • - IGroupV2ClanInfo + GroupV2ClanInfo
      • - IGroupV2ClanInfoAndInvestment + GroupV2ClanInfoAndInvestment
      • - IHyperlinkReference + HyperlinkReference
      • - IIgnoreResponse + IgnoreResponse +
      • +
      • + ImagePyramidEntry
      • - IInterpolationPoint + InterpolationPoint
      • - IInterpolationPointFloat + InterpolationPointFloat
      • - IOAuthResponse + OAuthResponse
      • - IPagedQuery + PagedQuery
      • - IPollResponse + PersonalDestinyVendorSaleItemSetComponent
      • - IPollResult + PollResponse
      • - IPostResponse + PollResult
      • - IPostSearchResponse + PostResponse
      • - IPublicPartnershipDetail + PostSearchResponse
      • -
      • - IQueryStringParameters +
      • + PublicDestinyVendorSaleItemSetComponent
      • - ISaveMessageResult + PublicPartnershipDetail +
      • +
      • + QueryStringParameters
      • - ISchemaRecordStateBlock + SchemaRecordStateBlock
      • - ISearchResultOfCommunityLiveStatus + SearchResultOfCommunityLiveStatus
      • - ISearchResultOfContentItemPublicContract + SearchResultOfContentItemPublicContract
      • - ISearchResultOfDestinyEntitySearchResultItem + SearchResultOfDestinyEntitySearchResultItem
      • - ISearchResultOfFireteamResponse + SearchResultOfFireteamResponse
      • - ISearchResultOfFireteamSummary + SearchResultOfFireteamSummary
      • - ISearchResultOfGroupBan + SearchResultOfGroupBan
      • - ISearchResultOfGroupMember + SearchResultOfGroupMember
      • - ISearchResultOfGroupMemberApplication + SearchResultOfGroupMemberApplication
      • - ISearchResultOfTrendingEntry + SearchResultOfTrendingEntry
      • - ISeries + Series
      • - IServerResponse + ServerResponse
      • - ISingleComponentResponse + SingleComponentResponse
      • - IStreamInfo + StreamInfo
      • - ITagMetadataDefinition + TagMetadataDefinition
      • - ITagMetadataItem + TagMetadataItem
      • - ITagResponse + TagResponse
      • - ITravelerConfig + TravelerConfig
      • - ITrendingCategories + TrendingCategories
      • - ITrendingCategory + TrendingCategory
      • - ITrendingDetail + TrendingDetail
      • - ITrendingEntry + TrendingEntry
      • - ITrendingEntryCommunityCreation + TrendingEntryCommunityCreation
      • - ITrendingEntryCommunityStream + TrendingEntryCommunityStream
      • - ITrendingEntryDestinyActivity + TrendingEntryDestinyActivity
      • - ITrendingEntryDestinyItem + TrendingEntryDestinyItem
      • - ITrendingEntryDestinyRitual + TrendingEntryDestinyRitual
      • - ITrendingEntryNews + TrendingEntryNews
      • - ITrendingEntrySupportArticle + TrendingEntrySupportArticle
      • - IUserInfoCard + UserInfoCard
      • - IUserMembership + UserMembership
      • - IUserMembershipData + UserMembershipData
      • - IUserTheme + UserTheme
      • - IUserToUserContext + UserToUserContext
      • App @@ -1993,9 +2005,6 @@

        Acknowledgments

      • Forum
      • -
      • - GroupV2 -
      • Trending
      • diff --git a/docs/interfaces/apiusage.html b/docs/interfaces/apiusage.html new file mode 100644 index 0000000..ff82ff6 --- /dev/null +++ b/docs/interfaces/apiusage.html @@ -0,0 +1,238 @@ + + + + + + ApiUsage | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface ApiUsage

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + ApiUsage +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        apiCalls

        +
        apiCalls: Series[]
        + +
        +
        +

        Counts for on API calls made for the time range.

        +
        +
        +
        +
        + +

        range

        +
        range: DateRange
        + +
        +
        +

        The date range for the data being reported.

        +
        +
        +
        +
        + +

        throttledRequests

        +
        throttledRequests: Series[]
        + +
        +
        +

        Instances of blocked requests or requests that crossed the warn threshold during + the time range.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/application.html b/docs/interfaces/application.html new file mode 100644 index 0000000..84a3005 --- /dev/null +++ b/docs/interfaces/application.html @@ -0,0 +1,404 @@ + + + + + + Application | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface Application

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + Application +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        applicationId

        +
        applicationId: number
        + +
        +
        +

        Unique ID assigned to the application

        +
        +
        +
        +
        + +

        applicationType

        +
        applicationType: OAuthApplicationType
        + +
        +
        + +

        creationDate

        +
        creationDate: string
        + +
        +
        +

        Date the application was first added to our database.

        +
        +
        +
        +
        + +

        firstPublished

        +
        firstPublished: string
        + +
        +
        +

        Date the first time the application status entered the 'Public' status.

        +
        +
        +
        +
        + +

        link

        +
        link: string
        + +
        +
        +

        Link to website for the application where a user can learn more about the app.

        +
        +
        +
        +
        + +

        name

        +
        name: string
        + +
        +
        +

        Name of the application

        +
        +
        +
        +
        + +

        origin

        +
        origin: string
        + +
        +
        +

        Value of the Origin header sent in requests generated by this application.

        +
        +
        +
        +
        + +

        redirectUrl

        +
        redirectUrl: string
        + +
        +
        +

        URL used to pass the user's authorization code to the application

        +
        +
        +
        +
        + +

        scope

        +
        scope: string
        + +
        +
        +

        Permissions the application needs to work

        +
        +
        +
        +
        + +

        status

        + + +
        +
        +

        Current status of the application.

        +
        +
        +
        +
        + +

        statusChanged

        +
        statusChanged: string
        + +
        +
        +

        Date the application status last changed.

        +
        +
        +
        +
        + +

        team

        + + +
        +
        +

        List of team members who manage this application on Bungie.net. Will always + consist of at least the application owner.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/applicationdeveloper.html b/docs/interfaces/applicationdeveloper.html new file mode 100644 index 0000000..623f1a2 --- /dev/null +++ b/docs/interfaces/applicationdeveloper.html @@ -0,0 +1,222 @@ + + + + + + ApplicationDeveloper | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface ApplicationDeveloper

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + ApplicationDeveloper +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        apiEulaVersion

        +
        apiEulaVersion: number
        + +
        +
        + +

        role

        + + +
        +
        + +

        user

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/awaauthorizationresult.html b/docs/interfaces/awaauthorizationresult.html new file mode 100644 index 0000000..16e9f78 --- /dev/null +++ b/docs/interfaces/awaauthorizationresult.html @@ -0,0 +1,330 @@ + + + + + + AwaAuthorizationResult | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface AwaAuthorizationResult

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + AwaAuthorizationResult +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        actionToken

        +
        actionToken: string
        + +
        +
        +

        Credential used to prove the user authorized an advanced write action.

        +
        +
        +
        +
        + +

        developerNote

        +
        developerNote: string
        + +
        +
        +

        Message to the app developer to help understand the response.

        +
        +
        +
        +
        + +

        maximumNumberOfUses

        +
        maximumNumberOfUses: number
        + +
        +
        +

        This token may be used to perform the requested action this number of times, at + a maximum. If this value is 0, then there is no limit.

        +
        +
        +
        +
        + +

        membershipType

        +
        membershipType: BungieMembershipType
        + +
        +
        +

        MembershipType from the permission request.

        +
        +
        +
        +
        + +

        responseReason

        +
        responseReason: AwaResponseReason
        + +
        +
        + +

        type

        +
        type: AwaType
        + +
        +
        +

        Advanced Write Action Type from the permission request.

        +
        +
        +
        +
        + +

        userSelection

        +
        userSelection: AwaUserSelection
        + +
        +
        +

        Indication of how the user responded to the request. If the value is "Approved" + the actionToken will contain the token that can be presented when performing the + advanced write action.

        +
        +
        +
        +
        + +

        Optional validUntil

        +
        validUntil: string
        + +
        +
        +

        Time, UTC, when token expires.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/awainitializeresponse.html b/docs/interfaces/awainitializeresponse.html new file mode 100644 index 0000000..edfa4d9 --- /dev/null +++ b/docs/interfaces/awainitializeresponse.html @@ -0,0 +1,219 @@ + + + + + + AwaInitializeResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface AwaInitializeResponse

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + AwaInitializeResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        correlationId

        +
        correlationId: string
        + +
        +
        +

        ID used to get the token. Present this ID to the user as it will identify this + specific request on their device.

        +
        +
        +
        +
        + +

        sentToSelf

        +
        sentToSelf: boolean
        + +
        +
        +

        True if the PUSH message will only be sent to the device that made this request.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/awapermissionrequested.html b/docs/interfaces/awapermissionrequested.html new file mode 100644 index 0000000..9914120 --- /dev/null +++ b/docs/interfaces/awapermissionrequested.html @@ -0,0 +1,258 @@ + + + + + + AwaPermissionRequested | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface AwaPermissionRequested

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + AwaPermissionRequested +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        Optional affectedItemId

        +
        affectedItemId: string
        + +
        +
        +

        Item instance ID the action shall be applied to. This is optional for all but a + new AwaType values. Rule of thumb is to provide the item instance ID if one is + available.

        +
        +
        +
        +
        + +

        Optional characterId

        +
        characterId: string
        + +
        +
        +

        Destiny character ID, if applicable, that will be affected by the action.

        +
        +
        +
        +
        + +

        membershipType

        +
        membershipType: BungieMembershipType
        + +
        +
        +

        Destiny membership type of the account to modify.

        +
        +
        +
        +
        + +

        type

        +
        type: AwaType
        + +
        +
        +

        Type of advanced write action.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/awauserresponse.html b/docs/interfaces/awauserresponse.html new file mode 100644 index 0000000..ccde674 --- /dev/null +++ b/docs/interfaces/awauserresponse.html @@ -0,0 +1,237 @@ + + + + + + AwaUserResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface AwaUserResponse

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + AwaUserResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        correlationId

        +
        correlationId: string
        + +
        +
        +

        Correlation ID of the request

        +
        +
        +
        +
        + +

        nonce

        +
        nonce: number[]
        + +
        +
        +

        Secret nonce received via the PUSH notification.

        +
        +
        +
        +
        + +

        selection

        +
        selection: AwaUserSelection
        + +
        +
        +

        Indication of the selection the user has made (Approving or rejecting the action)

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/clanbanner.html b/docs/interfaces/clanbanner.html new file mode 100644 index 0000000..d9e3b57 --- /dev/null +++ b/docs/interfaces/clanbanner.html @@ -0,0 +1,278 @@ + + + + + + ClanBanner | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface ClanBanner

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + ClanBanner +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        decalBackgroundColorId

        +
        decalBackgroundColorId: number
        + +
        +
        + +

        decalColorId

        +
        decalColorId: number
        + +
        +
        + +

        decalId

        +
        decalId: number
        + +
        +
        + +

        gonfalonColorId

        +
        gonfalonColorId: number
        + +
        +
        + +

        gonfalonDetailColorId

        +
        gonfalonDetailColorId: number
        + +
        +
        + +

        gonfalonDetailId

        +
        gonfalonDetailId: number
        + +
        +
        + +

        gonfalonId

        +
        gonfalonId: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/commentsummary.html b/docs/interfaces/commentsummary.html new file mode 100644 index 0000000..167075f --- /dev/null +++ b/docs/interfaces/commentsummary.html @@ -0,0 +1,208 @@ + + + + + + CommentSummary | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface CommentSummary

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + CommentSummary +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        commentCount

        +
        commentCount: number
        + +
        +
        + +

        topicId

        +
        topicId: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/communitylivestatus.html b/docs/interfaces/communitylivestatus.html new file mode 100644 index 0000000..e9e82b3 --- /dev/null +++ b/docs/interfaces/communitylivestatus.html @@ -0,0 +1,488 @@ + + + + + + CommunityLiveStatus | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface CommunityLiveStatus

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + CommunityLiveStatus +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activityModeHash

        +
        activityModeHash: number
        + +
        +
        + +

        currentActivityHash

        +
        currentActivityHash: number
        + +
        +
        + +

        currentViewers

        +
        currentViewers: number
        + +
        +
        + +

        Optional dateFeatured

        +
        dateFeatured: string
        + +
        +
        + +

        dateLastPlayed

        +
        dateLastPlayed: string
        + +
        +
        + +

        dateStatusUpdated

        +
        dateStatusUpdated: string
        + +
        +
        + +

        dateStreamStarted

        +
        dateStreamStarted: string
        + +
        +
        + +

        destinyCharacterId

        +
        destinyCharacterId: string
        + +
        +
        + +

        followers

        +
        followers: number
        + +
        +
        + +

        isFeatured

        +
        isFeatured: boolean
        + +
        +
        + +

        isSubscribable

        +
        isSubscribable: boolean
        + +
        +
        + +

        locale

        +
        locale: string
        + +
        +
        + +

        overallViewers

        +
        overallViewers: number
        + +
        +
        + +

        partnershipIdentifier

        +
        partnershipIdentifier: string
        + +
        +
        + +

        partnershipType

        +
        partnershipType: PartnershipType
        + +
        +
        + +

        thumbnail

        +
        thumbnail: string
        + +
        +
        + +

        thumbnailLarge

        +
        thumbnailLarge: string
        + +
        +
        + +

        thumbnailSmall

        +
        thumbnailSmall: string
        + +
        +
        + +

        title

        +
        title: string
        + +
        +
        + +

        trendingValue

        +
        trendingValue: number
        + +
        +
        + +

        url

        +
        url: string
        + +
        +
        + +

        userInfo

        +
        userInfo: UserInfoCard
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/contentitempubliccontract.html b/docs/interfaces/contentitempubliccontract.html new file mode 100644 index 0000000..1ecb760 --- /dev/null +++ b/docs/interfaces/contentitempubliccontract.html @@ -0,0 +1,410 @@ + + + + + + ContentItemPublicContract | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface ContentItemPublicContract

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + ContentItemPublicContract +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        allowComments

        +
        allowComments: boolean
        + +
        +
        + +

        author

        +
        author: GeneralUser
        + +
        +
        + +

        autoEnglishPropertyFallback

        +
        autoEnglishPropertyFallback: boolean
        + +
        +
        + +

        cType

        +
        cType: string
        + +
        +
        + +

        cmsPath

        +
        cmsPath: string
        + +
        +
        + +

        commentSummary

        +
        commentSummary: CommentSummary
        + +
        +
        + +

        contentId

        +
        contentId: string
        + +
        +
        + +

        creationDate

        +
        creationDate: string
        + +
        +
        + +

        hasAgeGate

        +
        hasAgeGate: boolean
        + +
        +
        + +

        minimumAge

        +
        minimumAge: number
        + +
        +
        + +

        modifyDate

        +
        modifyDate: string
        + +
        +
        + +

        properties

        +
        properties: object
        + +
        +
        +

        Firehose content is really a collection of metadata and "properties", which are + the potentially-but-not-strictly localizable data that comprises the meat of + whatever content is being shown.

        +
        +

        As Cole Porter would have crooned, "Anything Goes" with Firehose properties. + They are most often strings, but they can theoretically be anything. They are + JSON encoded, and could be JSON structures, simple strings, numbers etc... The + Content Type of the item (cType) will describe the properties, and thus how they + ought to be deserialized.

        +
        +
        +

        Type declaration

        +
          +
        • +
          [key: string]: object
          +
        • +
        +
        +
        +
        + +

        ratingImagePath

        +
        ratingImagePath: string
        + +
        +
        + +

        representations

        +
        representations: ContentRepresentation[]
        + +
        +
        + +

        tags

        +
        tags: string[]
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/contentpreview.html b/docs/interfaces/contentpreview.html new file mode 100644 index 0000000..196ed91 --- /dev/null +++ b/docs/interfaces/contentpreview.html @@ -0,0 +1,264 @@ + + + + + + ContentPreview | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface ContentPreview

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + ContentPreview +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        itemInSet

        +
        itemInSet: boolean
        + +
        +
        + +

        name

        +
        name: string
        + +
        +
        + +

        path

        +
        path: string
        + +
        +
        + +

        setNesting

        +
        setNesting: number
        + +
        +
        + +

        setTag

        +
        setTag: string
        + +
        +
        + +

        useSetId

        +
        useSetId: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/contentrepresentation.html b/docs/interfaces/contentrepresentation.html new file mode 100644 index 0000000..77e882c --- /dev/null +++ b/docs/interfaces/contentrepresentation.html @@ -0,0 +1,222 @@ + + + + + + ContentRepresentation | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface ContentRepresentation

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + ContentRepresentation +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        name

        +
        name: string
        + +
        +
        + +

        path

        +
        path: string
        + +
        +
        + +

        validationString

        +
        validationString: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/contenttypedefaultvalue.html b/docs/interfaces/contenttypedefaultvalue.html new file mode 100644 index 0000000..69ad787 --- /dev/null +++ b/docs/interfaces/contenttypedefaultvalue.html @@ -0,0 +1,222 @@ + + + + + + ContentTypeDefaultValue | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface ContentTypeDefaultValue

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + ContentTypeDefaultValue +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        defaultValue

        +
        defaultValue: string
        + +
        +
        + +

        whenClause

        +
        whenClause: string
        + +
        +
        + +

        whenValue

        +
        whenValue: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/contenttypedescription.html b/docs/interfaces/contenttypedescription.html new file mode 100644 index 0000000..239b38b --- /dev/null +++ b/docs/interfaces/contenttypedescription.html @@ -0,0 +1,482 @@ + + + + + + ContentTypeDescription | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface ContentTypeDescription

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + ContentTypeDescription +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        allowComments

        +
        allowComments: boolean
        + +
        +
        + +

        autoEnglishPropertyFallback

        +
        autoEnglishPropertyFallback: boolean
        + +
        +
        + +

        bindIdentifierToProperty

        +
        bindIdentifierToProperty: string
        + +
        +
        + +

        boundRegex

        +
        boundRegex: string
        + +
        +
        + +

        bulkUploadable

        +
        bulkUploadable: boolean
        + +
        +
        + +

        cType

        +
        cType: string
        + +
        +
        + +

        contentDescription

        +
        contentDescription: string
        + +
        +
        + +

        forceIdentifierBinding

        +
        forceIdentifierBinding: boolean
        + +
        +
        + +

        name

        +
        name: string
        + +
        +
        + +

        previewImage

        +
        previewImage: string
        + +
        +
        + +

        previews

        +
        previews: ContentPreview[]
        + +
        +
        + +

        priority

        +
        priority: number
        + +
        +
        + +

        properties

        +
        properties: ContentTypeProperty[]
        + +
        +
        + +

        propertySections

        +
        propertySections: ContentTypePropertySection[]
        + +
        +
        + +

        reminder

        +
        reminder: string
        + +
        +
        + +

        showInContentEditor

        +
        showInContentEditor: boolean
        + +
        +
        + +

        suppressCmsPath

        +
        suppressCmsPath: boolean
        + +
        +
        + +

        tagMetadata

        +
        tagMetadata: TagMetadataDefinition[]
        + +
        +
        + +

        tagMetadataItems

        +
        tagMetadataItems: object
        + +
        +

        Type declaration

        + +
        +
        +
        + +

        typeOf

        +
        typeOf: string
        + +
        +
        + +

        usageExamples

        +
        usageExamples: string[]
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/contenttypeproperty.html b/docs/interfaces/contenttypeproperty.html new file mode 100644 index 0000000..031e83c --- /dev/null +++ b/docs/interfaces/contenttypeproperty.html @@ -0,0 +1,770 @@ + + + + + + ContentTypeProperty | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface ContentTypeProperty

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + ContentTypeProperty +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        attributes

        +
        attributes: object
        + +
        +

        Type declaration

        +
          +
        • +
          [key: string]: string
          +
        • +
        +
        +
        +
        + +

        bindToProperty

        +
        bindToProperty: string
        + +
        +
        + +

        boundRegex

        +
        boundRegex: string
        + +
        +
        + +

        childProperties

        +
        childProperties: ContentTypeProperty[]
        + +
        +
        + +

        contentTypeAllowed

        +
        contentTypeAllowed: string
        + +
        +
        + +

        datatype

        + + +
        +
        + +

        defaultValues

        +
        defaultValues: ContentTypeDefaultValue[]
        + +
        +
        + +

        enabled

        +
        enabled: boolean
        + +
        +
        + +

        entitytype

        +
        entitytype: string
        + +
        +
        + +

        fallback

        +
        fallback: boolean
        + +
        +
        + +

        isCombo

        +
        isCombo: boolean
        + +
        +
        + +

        isExternalAllowed

        +
        isExternalAllowed: boolean
        + +
        +
        + +

        isImage

        +
        isImage: boolean
        + +
        +
        + +

        isTitle

        +
        isTitle: boolean
        + +
        +
        + +

        isVideo

        +
        isVideo: boolean
        + +
        +
        + +

        legalContentTypes

        +
        legalContentTypes: string[]
        + +
        +
        + +

        localizable

        +
        localizable: boolean
        + +
        +
        + +

        maxByteLength

        +
        maxByteLength: number
        + +
        +
        + +

        maxFileSize

        +
        maxFileSize: number
        + +
        +
        + +

        maxHeight

        +
        maxHeight: number
        + +
        +
        + +

        maxLength

        +
        maxLength: number
        + +
        +
        + +

        maxWidth

        +
        maxWidth: number
        + +
        +
        + +

        minHeight

        +
        minHeight: number
        + +
        +
        + +

        minWidth

        +
        minWidth: number
        + +
        +
        + +

        name

        +
        name: string
        + +
        +
        + +

        order

        +
        order: number
        + +
        +
        + +

        propertyDescription

        +
        propertyDescription: string
        + +
        +
        + +

        propertySection

        +
        propertySection: string
        + +
        +
        + +

        readableName

        +
        readableName: string
        + +
        +
        + +

        regexp

        +
        regexp: string
        + +
        +
        + +

        representationSelection

        +
        representationSelection: object
        + +
        +

        Type declaration

        +
          +
        • +
          [key: string]: string
          +
        • +
        +
        +
        +
        + +

        representationValidationString

        +
        representationValidationString: string
        + +
        +
        + +

        required

        +
        required: boolean
        + +
        +
        + +

        rssAttribute

        +
        rssAttribute: string
        + +
        +
        + +

        suppressProperty

        +
        suppressProperty: boolean
        + +
        +
        + +

        validateAs

        +
        validateAs: string
        + +
        +
        + +

        value

        +
        value: string
        + +
        +
        + +

        visible

        +
        visible: boolean
        + +
        +
        + +

        visibleDependency

        +
        visibleDependency: string
        + +
        +
        + +

        visibleOn

        +
        visibleOn: string
        + +
        +
        + +

        weight

        +
        weight: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/contenttypepropertysection.html b/docs/interfaces/contenttypepropertysection.html new file mode 100644 index 0000000..de3c1d1 --- /dev/null +++ b/docs/interfaces/contenttypepropertysection.html @@ -0,0 +1,222 @@ + + + + + + ContentTypePropertySection | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface ContentTypePropertySection

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + ContentTypePropertySection +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        collapsed

        +
        collapsed: boolean
        + +
        +
        + +

        name

        +
        name: string
        + +
        +
        + +

        readableName

        +
        readableName: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/datapoint.html b/docs/interfaces/datapoint.html new file mode 100644 index 0000000..bd36529 --- /dev/null +++ b/docs/interfaces/datapoint.html @@ -0,0 +1,218 @@ + + + + + + Datapoint | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface Datapoint

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + Datapoint +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        Optional count

        +
        count: number
        + +
        +
        +

        Count associated with timestamp

        +
        +
        +
        +
        + +

        time

        +
        time: string
        + +
        +
        +

        Timestamp for the related count.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/daterange.html b/docs/interfaces/daterange.html new file mode 100644 index 0000000..e1b3e4d --- /dev/null +++ b/docs/interfaces/daterange.html @@ -0,0 +1,208 @@ + + + + + + DateRange | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DateRange

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DateRange +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        end

        +
        end: string
        + +
        +
        + +

        start

        +
        start: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivity.html b/docs/interfaces/destinyactivity.html new file mode 100644 index 0000000..21f4832 --- /dev/null +++ b/docs/interfaces/destinyactivity.html @@ -0,0 +1,368 @@ + + + + + + DestinyActivity | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivity

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents the "Live" data that we can obtain about a Character's status with a + specific Activity. This will tell you whether the character can participate in + the activity, as well as some other basic mutable information.

        +
        +

        Meant to be combined with static DestinyActivityDefinition data for a full + picture of the Activity.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivity +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activityHash

        +
        activityHash: number
        + +
        +
        +

        The hash identifier of the Activity. Use this to look up the + DestinyActivityDefinition of the activity.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        canJoin

        +
        canJoin: boolean
        + +
        +
        +

        If true, the user is allowed to join with another Fireteam in this activity.

        +
        +
        +
        +
        + +

        canLead

        +
        canLead: boolean
        + +
        +
        +

        If true, the user is allowed to lead a Fireteam into this activity.

        +
        +
        +
        +
        + +

        difficultyTier

        + + +
        +
        +

        A DestinyActivityDifficultyTier enum value indicating the difficulty of the + activity.

        +
        +
        +
        +
        + +

        Optional displayLevel

        +
        displayLevel: number
        + +
        +
        +

        The difficulty level of the activity, if applicable.

        +
        +
        +
        +
        + +

        isCompleted

        +
        isCompleted: boolean
        + +
        +
        +

        If true, we both have the ability to know that the user has completed this + activity and they have completed it. Unfortunately, we can't necessarily know + this for all activities. As such, this should probably only be used if you + already know in advance which specific activities you wish to check.

        +
        +
        +
        +
        + +

        isNew

        +
        isNew: boolean
        + +
        +
        +

        If true, then the activity should have a "new" indicator in the Director UI.

        +
        +
        +
        +
        + +

        isVisible

        +
        isVisible: boolean
        + +
        +
        +

        If true, the user should be able to see this activity.

        +
        +
        +
        +
        + +

        Optional recommendedLight

        +
        recommendedLight: number
        + +
        +
        +

        The recommended light level for the activity, if applicable.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitychallengedefinition.html b/docs/interfaces/destinyactivitychallengedefinition.html new file mode 100644 index 0000000..5afb1c6 --- /dev/null +++ b/docs/interfaces/destinyactivitychallengedefinition.html @@ -0,0 +1,230 @@ + + + + + + DestinyActivityChallengeDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityChallengeDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents a reference to a Challenge, which for now is just an Objective.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityChallengeDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        dummyRewards

        +
        dummyRewards: DestinyItemQuantity[]
        + +
        +
        +

        The rewards as they're represented in the UI. Note that they generally link to " + dummy" items that give a summary of rewards rather than direct, real items + themselves.

        +
        +

        If the quantity is 0, don't show the quantity.

        +
        +
        +
        + +

        objectiveHash

        +
        objectiveHash: number
        + +
        +
        +

        The hash for the Objective that matches this challenge. Use it to look up the + DestinyObjectiveDefinition.

        +
        +

        Mapped to DestinyObjectiveDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitydefinition.html b/docs/interfaces/destinyactivitydefinition.html new file mode 100644 index 0000000..6586fe2 --- /dev/null +++ b/docs/interfaces/destinyactivitydefinition.html @@ -0,0 +1,884 @@ + + + + + + DestinyActivityDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The static data about Activities in Destiny 2.

        +
        +

        Note that an Activity must be combined with an ActivityMode to know - from a + Gameplay perspective - what the user is "Playing".

        +

        In most PvE activities, this is fairly straightforward. A Story Activity can + only be played in the Story Activity Mode.

        +

        However, in PvP activities, the Activity alone only tells you the map being + played, or the Playlist that the user chose to enter. You'll need to know the + Activity Mode they're playing to know that they're playing Mode X on Map Y.

        +

        Activity Definitions tell a great deal of information about what could be + relevant to a user: what rewards they can earn, what challenges could be + performed, what modifiers could be applied. To figure out which of these + properties is actually live, you'll need to combine the definition with "Live" + data from one of the Destiny endpoints.

        +

        Activities also have Activity Types, but unfortunately in Destiny 2 these are + even less reliable of a source of information than they were in Destiny 1. I + will be looking into ways to provide more reliable sources for type information + as time goes on, but for now we're going to have to deal with the limitations. + See DestinyActivityTypeDefinition for more information.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activityGraphList

        + + +
        +
        +

        Unfortunately, in practice this is almost never populated. In theory, this is + supposed to tell which Activity Graph to show if you bring up the director while + in this activity.

        +
        +
        +
        +
        + +

        activityLevel

        +
        activityLevel: number
        + +
        +
        +

        The difficulty level of the activity.

        +
        +
        +
        +
        + +

        activityLightLevel

        +
        activityLightLevel: number
        + +
        +
        +

        The recommended light level for this activity.

        +
        +
        +
        +
        + +

        activityLocationMappings

        +
        activityLocationMappings: DestinyEnvironmentLocationMapping[]
        + +
        +
        +

        A list of location mappings that are affected by this activity. Pulled out of + DestinyLocationDefinitions for our/your lookup convenience.

        +
        +
        +
        +
        + +

        activityModeHashes

        +
        activityModeHashes: number[]
        + +
        +
        +

        The hash identifiers for Activity Modes relevant to this activity. Note that if + this is a playlist, the specific playlist entry chosen will determine the actual + activity modes that end up being relevant.

        +
        +

        Mapped to DestinyActivityModeDefinition in the manifest.

        +
        +
        +
        + +

        activityModeTypes

        +
        activityModeTypes: DestinyActivityModeType[]
        + +
        +
        +

        The activity modes - if any - in enum form. Because we can't seem to escape the + enums.

        +
        +
        +
        +
        + +

        activityTypeHash

        +
        activityTypeHash: number
        + +
        +
        +

        The hash identifier for the Activity Type of this Activity. You may use it to + look up the DestinyActivityTypeDefinition for human readable info, but be + forewarned: Playlists and many PVP Map Activities will map to generic Activity + Types. You'll have to use your knowledge of the Activity Mode being played to + get more specific information about what the user is playing.

        +
        +

        Mapped to DestinyActivityTypeDefinition in the manifest.

        +
        +
        +
        + +

        challenges

        + + +
        +
        +

        An activity can have many Challenges, of which any subset of them may be active + for play at any given period of time. This gives the information about the + challenges and data that we use to understand when they're active and what + rewards they provide. Sadly, at the moment there's no central definition for + challenges: much like "Skulls" were in Destiny 1, these are defined on + individual activities and there can be many duplicates/near duplicates across + the Destiny 2 ecosystem. I have it in mind to centralize these in a future + revision of the API, but we are out of time.

        +
        +
        +
        +
        + +

        destinationHash

        +
        destinationHash: number
        + +
        +
        +

        The hash identifier for the Destination on which this Activity is played. Use it + to look up the DestinyDestinationDefinition for human readable info about the + destination. A Destination can be thought of as a more specific location than a " + Place". For instance, if the "Place" is Earth, the "Destination" would be a + specific city or region on Earth.

        +
        +

        Mapped to DestinyDestinationDefinition in the manifest.

        +
        +
        +
        + +

        Optional directActivityModeHash

        +
        directActivityModeHash: number
        + +
        +
        +

        If this activity had an activity mode directly defined on it, this will be the + hash of that mode.

        +
        +

        Mapped to DestinyActivityModeDefinition in the manifest.

        +
        +
        +
        + +

        Optional directActivityModeType

        +
        directActivityModeType: number
        + +
        +
        +

        If the activity had an activity mode directly defined on it, this will be the + enum value of that mode.

        +
        +
        +
        +
        + +

        displayProperties

        + + +
        +
        +

        The title, subtitle, and icon for the activity. We do a little post-processing + on this to try and account for Activities where the designers have left this + data too minimal to determine what activity is actually being played.

        +
        +
        +
        +
        + +

        guidedGame

        + + +
        +
        +

        This block of data, if it exists, provides information about the guided game + experience and restrictions for this activity. If it doesn't exist, the game is + not able to be played as a guided game.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        insertionPoints

        + + +
        +
        +

        The list of phases or points of entry into an activity, along with information + we can use to determine their gating and availability.

        +
        +
        +
        +
        + +

        isPlaylist

        +
        isPlaylist: boolean
        + +
        +
        +

        If True, this Activity is actually a Playlist that refers to multiple possible + specific Activities and Activity Modes. For instance, a Crucible Playlist may + have references to multiple Activities (Maps) with multiple Activity Modes ( + specific PvP gameplay modes). If this is true, refer to the playlistItems + property for the specific entries in the playlist.

        +
        +
        +
        +
        + +

        isPvP

        +
        isPvP: boolean
        + +
        +
        +

        If true, this activity is a PVP activity or playlist.

        +
        +
        +
        +
        + +

        loadouts

        + + +
        +
        +

        The set of all possible loadout requirements that could be active for this + activity. Only one will be active at any given time, and you can discover which + one through activity-associated data such as Milestones that have activity info + on them.

        +
        +
        +
        +
        + +

        matchmaking

        + + +
        +
        +

        This block of data provides information about the Activity's matchmaking + attributes: how many people can join and such.

        +
        +
        +
        +
        + +

        modifiers

        + + +
        +
        +

        Activities can have Modifiers, as defined in DestinyActivityModifierDefinition. + These are references to the modifiers that can be applied to that activity, + along with data that we use to determine if that modifier is actually active at + any given point in time.

        +
        +
        +
        +
        + +

        optionalUnlockStrings

        +
        optionalUnlockStrings: DestinyActivityUnlockStringDefinition[]
        + +
        +
        +

        If there are status strings related to the activity and based on internal state + of the game, account, or character, then this will be the definition of those + strings and the states needed in order for the strings to be shown.

        +
        +
        +
        +
        + +

        originalDisplayProperties

        +
        originalDisplayProperties: DestinyDisplayPropertiesDefinition
        + +
        +
        +

        The unadulterated form of the display properties, as they ought to be shown in + the Director (if the activity appears in the director).

        +
        +
        +
        +
        + +

        pgcrImage

        +
        pgcrImage: string
        + +
        +
        +

        When Activities are completed, we generate a "Post-Game Carnage Report", or PGCR, + with details about what happened in that activity (how many kills someone got, + which team won, etc...) We use this image as the background when displaying PGCR + information, and often use it when we refer to the Activity in general.

        +
        +
        +
        +
        + +

        placeHash

        +
        placeHash: number
        + +
        +
        +

        The hash identifier for the "Place" on which this Activity is played. Use it to + look up the DestinyPlaceDefinition for human readable info about the Place. A + Place is the largest-scoped concept for location information. For instance, if + the "Place" is Earth, the "Destination" would be a specific city or region on + Earth.

        +
        +

        Mapped to DestinyPlaceDefinition in the manifest.

        +
        +
        +
        + +

        playlistItems

        + + +
        +
        +

        Represents all of the possible activities that could be played in the Playlist, + along with information that we can use to determine if they are active at the + present time.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        releaseIcon

        +
        releaseIcon: string
        + +
        +
        +

        If the activity has an icon associated with a specific release (such as a DLC), + this is the path to that release's icon.

        +
        +
        +
        +
        + +

        releaseTime

        +
        releaseTime: number
        + +
        +
        +

        If the activity will not be visible until a specific and known time, this will + be the seconds since the Epoch when it will become visible.

        +
        +
        +
        +
        + +

        rewards

        + + +
        +
        +

        The expected possible rewards for the activity. These rewards may or may not be + accessible for an individual player based on their character state, the account + state, and even the game's state overall. But it is a useful reference for + possible rewards you can earn in the activity. These match up to rewards + displayed when you hover over the Activity in the in-game Director, and often + refer to Placeholder or "Dummy" items: items that tell you what you can earn in + vague terms rather than what you'll specifically be earning (partly because the + game doesn't even know what you'll earn specifically until you roll for it at + the end)

        +
        +
        +
        +
        + +

        selectionScreenDisplayProperties

        +
        selectionScreenDisplayProperties: DestinyDisplayPropertiesDefinition
        + +
        +
        +

        The title, subtitle, and icon for the activity as determined by Selection Screen + data, if there is any for this activity. There won't be data in this field if + the activity is never shown in a selection/options screen.

        +
        +
        +
        +
        + +

        tier

        +
        tier: number
        + +
        +
        +

        The difficulty tier of the activity.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitygraphartelementdefinition.html b/docs/interfaces/destinyactivitygraphartelementdefinition.html new file mode 100644 index 0000000..560b9fc --- /dev/null +++ b/docs/interfaces/destinyactivitygraphartelementdefinition.html @@ -0,0 +1,209 @@ + + + + + + DestinyActivityGraphArtElementDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityGraphArtElementDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        These Art Elements are meant to represent one-off visual effects overlaid on the + map. Currently, we do not have a pipeline to import the assets for these + overlays, so this info exists as a placeholder for when such a pipeline exists ( + if it ever will)

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityGraphArtElementDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        position

        + + +
        +
        +

        The position on the map of the art element.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitygraphconnectiondefinition.html b/docs/interfaces/destinyactivitygraphconnectiondefinition.html new file mode 100644 index 0000000..556cb50 --- /dev/null +++ b/docs/interfaces/destinyactivitygraphconnectiondefinition.html @@ -0,0 +1,217 @@ + + + + + + DestinyActivityGraphConnectionDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityGraphConnectionDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Nodes on a graph can be visually connected: this appears to be the information + about which nodes to link. It appears to lack more detailed information, such as + the path for that linking.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityGraphConnectionDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        destNodeHash

        +
        destNodeHash: number
        + +
        +
        + +

        sourceNodeHash

        +
        sourceNodeHash: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitygraphdefinition.html b/docs/interfaces/destinyactivitygraphdefinition.html new file mode 100644 index 0000000..d883fbe --- /dev/null +++ b/docs/interfaces/destinyactivitygraphdefinition.html @@ -0,0 +1,381 @@ + + + + + + DestinyActivityGraphDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityGraphDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents a Map View in the director: be them overview views, destination views, + or other.

        +
        +

        They have nodes which map to activities, and other various visual elements that + we (or others) may or may not be able to use.

        +

        Activity graphs, most importantly, have nodes which can have activities in + various states of playability.

        +

        Unfortunately, activity graphs are combined at runtime with Game UI-only assets + such as fragments of map images, various in-game special effects, decals etc... + that we don't get in these definitions.

        +

        If we end up having time, we may end up trying to manually populate those here: + but the last time we tried that, before the lead-up to D1, it proved to be + unmaintainable as the game's content changed. So don't bet the farm on us + providing that content in this definition.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityGraphDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        artElements

        + + +
        +
        +

        Represents one-off/special UI elements that appear on the map.

        +
        +
        +
        +
        + +

        connections

        + + +
        +
        +

        Represents connections between graph nodes. However, it lacks context that we'd + need to make good use of it.

        +
        +
        +
        +
        + +

        displayObjectives

        + + +
        +
        +

        Objectives can display on maps, and this is supposedly metadata for that. I have + not had the time to analyze the details of what is useful within however: we + could be missing important data to make this work. Expect this property to be + expanded on later if possible.

        +
        +
        +
        +
        + +

        displayProgressions

        + + +
        +
        +

        Progressions can also display on maps, but similarly to displayObjectives we + appear to lack some required information and context right now. We will have to + look into it later and add more data if possible.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        linkedGraphs

        + + +
        +
        +

        Represents links between this Activity Graph and other ones.

        +
        +
        +
        +
        + +

        nodes

        + + +
        +
        +

        These represent the visual "nodes" on the map's view. These are the activities + you can click on in the map.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitygraphdisplayobjectivedefinition.html b/docs/interfaces/destinyactivitygraphdisplayobjectivedefinition.html new file mode 100644 index 0000000..460b81b --- /dev/null +++ b/docs/interfaces/destinyactivitygraphdisplayobjectivedefinition.html @@ -0,0 +1,228 @@ + + + + + + DestinyActivityGraphDisplayObjectiveDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityGraphDisplayObjectiveDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        When a Graph needs to show active Objectives, this defines those objectives as + well as an identifier.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityGraphDisplayObjectiveDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        id

        +
        id: number
        + +
        +
        +

        $NOTE $amola 2017-01-19 This field is apparently something that CUI uses to + manually wire up objectives to display info. I am unsure how it works.

        +
        +
        +
        +
        + +

        objectiveHash

        +
        objectiveHash: number
        + +
        +
        +

        The objective being shown on the map.

        +
        +

        Mapped to DestinyObjectiveDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitygraphdisplayprogressiondefinition.html b/docs/interfaces/destinyactivitygraphdisplayprogressiondefinition.html new file mode 100644 index 0000000..f9ce3de --- /dev/null +++ b/docs/interfaces/destinyactivitygraphdisplayprogressiondefinition.html @@ -0,0 +1,216 @@ + + + + + + DestinyActivityGraphDisplayProgressionDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityGraphDisplayProgressionDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        When a Graph needs to show active Progressions, this defines those objectives as + well as an identifier.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityGraphDisplayProgressionDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        id

        +
        id: number
        + +
        +
        + +

        progressionHash

        +
        progressionHash: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitygraphlistentrydefinition.html b/docs/interfaces/destinyactivitygraphlistentrydefinition.html new file mode 100644 index 0000000..a394087 --- /dev/null +++ b/docs/interfaces/destinyactivitygraphlistentrydefinition.html @@ -0,0 +1,211 @@ + + + + + + DestinyActivityGraphListEntryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityGraphListEntryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Destinations and Activities may have default Activity Graphs that should be + shown when you bring up the Director and are playing in either.

        +
        +

        This contract defines the graph referred to and the gating for when it is + relevant.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityGraphListEntryDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activityGraphHash

        +
        activityGraphHash: number
        + +
        +
        +

        The hash identifier of the DestinyActivityGraphDefinition that should be shown + when opening the director.

        +
        +

        Mapped to DestinyActivityGraphDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitygraphnodeactivitydefinition.html b/docs/interfaces/destinyactivitygraphnodeactivitydefinition.html new file mode 100644 index 0000000..fd4a95f --- /dev/null +++ b/docs/interfaces/destinyactivitygraphnodeactivitydefinition.html @@ -0,0 +1,235 @@ + + + + + + DestinyActivityGraphNodeActivityDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityGraphNodeActivityDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The actual activity to be redirected to when you click on the node. Note that a + node can have many Activities attached to it: but only one will be active at any + given time. The list of Node Activities will be traversed, and the first one + found to be active will be displayed. This way, a node can layer multiple + variants of an activity on top of each other. For instance, one node can control + the weekly Crucible Playlist. There are multiple possible playlists, but only + one is active for the week.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityGraphNodeActivityDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activityHash

        +
        activityHash: number
        + +
        +
        +

        The activity that will be activated if the user clicks on this node. Controls + all activity-related information displayed on the node if it is active (the text + shown in the tooltip etc)

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        nodeActivityId

        +
        nodeActivityId: number
        + +
        +
        +

        An identifier for this node activity. It is only guaranteed to be unique within + the Activity Graph.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitygraphnodedefinition.html b/docs/interfaces/destinyactivitygraphnodedefinition.html new file mode 100644 index 0000000..8231b2c --- /dev/null +++ b/docs/interfaces/destinyactivitygraphnodedefinition.html @@ -0,0 +1,315 @@ + + + + + + DestinyActivityGraphNodeDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityGraphNodeDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This is the position and other data related to nodes in the activity graph that + you can click to launch activities. An Activity Graph node will only have one + active Activity at a time, which will determine the activity to be launched (and, + unless overrideDisplay information is provided, will also determine the tooltip + and other UI related to the node)

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityGraphNodeDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activities

        + + +
        +
        +

        The node may have various possible activities that could be active for it, + however only one may be active at a time. See the + DestinyActivityGraphNodeActivityDefinition for details.

        +
        +
        +
        +
        + +

        featuringStates

        + + +
        +
        +

        The node may have various visual accents placed on it, or styles applied. These + are the list of possible styles that the Node can have. The game iterates + through each, looking for the first one that passes a check of the required game/ + character/account state in order to show that style, and then renders the node + in that style.

        +
        +
        +
        +
        + +

        nodeId

        +
        nodeId: number
        + +
        +
        +

        An identifier for the Activity Graph Node, only guaranteed to be unique within + its parent Activity Graph.

        +
        +
        +
        +
        + +

        overrideDisplay

        + + +
        +
        +

        The node may have display properties that override the active Activity's + display properties.

        +
        +
        +
        +
        + +

        position

        + + +
        +
        +

        The position on the map for this node.

        +
        +
        +
        +
        + +

        states

        + + +
        +
        +

        Represents possible states that the graph node can be in. These are combined + with some checking that happens in the game client and server to determine which + state is actually active at any given time.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitygraphnodefeaturingstatedefinition.html b/docs/interfaces/destinyactivitygraphnodefeaturingstatedefinition.html new file mode 100644 index 0000000..f21c581 --- /dev/null +++ b/docs/interfaces/destinyactivitygraphnodefeaturingstatedefinition.html @@ -0,0 +1,211 @@ + + + + + + DestinyActivityGraphNodeFeaturingStateDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityGraphNodeFeaturingStateDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Nodes can have different visual states. This object represents a single visual + state ("highlight type") that a node can be in, and the unlock expression + condition to determine whether it should be set.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityGraphNodeFeaturingStateDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        highlightType

        + + +
        +
        +

        The node can be highlighted in a variety of ways - the game iterates through + these and finds the first FeaturingState that is valid at the present moment + given the Game, Account, and Character state, and renders the node in that state. + See the ActivityGraphNodeHighlightType enum for possible values.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitygraphnodestateentry.html b/docs/interfaces/destinyactivitygraphnodestateentry.html new file mode 100644 index 0000000..b0ebb8f --- /dev/null +++ b/docs/interfaces/destinyactivitygraphnodestateentry.html @@ -0,0 +1,203 @@ + + + + + + DestinyActivityGraphNodeStateEntry | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityGraphNodeStateEntry

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents a single state that a graph node might end up in. Depending on what's + going on in the game, graph nodes could be shown in different ways or even + excluded from view entirely.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityGraphNodeStateEntry +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        state

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivityguidedblockdefinition.html b/docs/interfaces/destinyactivityguidedblockdefinition.html new file mode 100644 index 0000000..0a1e272 --- /dev/null +++ b/docs/interfaces/destinyactivityguidedblockdefinition.html @@ -0,0 +1,246 @@ + + + + + + DestinyActivityGuidedBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityGuidedBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Guided Game information for this activity.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityGuidedBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        guidedDisbandCount

        +
        guidedDisbandCount: number
        + +
        +
        +

        If -1, the guided group cannot be disbanded. Otherwise, take the total # of + players in the activity and subtract this number: that is the total # of votes + needed for the guided group to disband.

        +
        +
        +
        +
        + +

        guidedMaxLobbySize

        +
        guidedMaxLobbySize: number
        + +
        +
        +

        The maximum amount of people that can be in the waiting lobby.

        +
        +
        +
        +
        + +

        guidedMinLobbySize

        +
        guidedMinLobbySize: number
        + +
        +
        +

        The minimum amount of people that can be in the waiting lobby.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivityhistoryresults.html b/docs/interfaces/destinyactivityhistoryresults.html new file mode 100644 index 0000000..33c3967 --- /dev/null +++ b/docs/interfaces/destinyactivityhistoryresults.html @@ -0,0 +1,199 @@ + + + + + + DestinyActivityHistoryResults | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityHistoryResults

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityHistoryResults +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activities

        + + +
        +
        +

        List of activities, the most recent activity first.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivityinsertionpointdefinition.html b/docs/interfaces/destinyactivityinsertionpointdefinition.html new file mode 100644 index 0000000..63e8ae8 --- /dev/null +++ b/docs/interfaces/destinyactivityinsertionpointdefinition.html @@ -0,0 +1,214 @@ + + + + + + DestinyActivityInsertionPointDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityInsertionPointDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A point of entry into an activity, gated by an unlock flag and with some more-or- + less useless (for our purposes) phase information. I'm including it in case we + end up being able to bolt more useful information onto it in the future.

        +
        +

        UPDATE: Turns out this information isn't actually useless, and is in fact + actually useful for people. Who would have thought? We still don't have + localized info for it, but at least this will help people when they're looking + at phase indexes in stats data, or when they want to know what phases have been + completed on a weekly achievement.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityInsertionPointDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        phaseHash

        +
        phaseHash: number
        + +
        +
        +

        A unique hash value representing the phase. This can be useful for, for example, + comparing how different instances of Raids have phases in different orders!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivityloadoutrequirement.html b/docs/interfaces/destinyactivityloadoutrequirement.html new file mode 100644 index 0000000..ba1168b --- /dev/null +++ b/docs/interfaces/destinyactivityloadoutrequirement.html @@ -0,0 +1,232 @@ + + + + + + DestinyActivityLoadoutRequirement | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityLoadoutRequirement

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityLoadoutRequirement +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        allowedEquippedItemHashes

        +
        allowedEquippedItemHashes: number[]
        + +
        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        +
        + +

        allowedWeaponSubTypes

        +
        allowedWeaponSubTypes: DestinyItemSubType[]
        + +
        +
        + +

        equipmentSlotHash

        +
        equipmentSlotHash: number
        + +
        +
        +

        Mapped to DestinyEquipmentSlotDefinition in the manifest.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivityloadoutrequirementset.html b/docs/interfaces/destinyactivityloadoutrequirementset.html new file mode 100644 index 0000000..1948846 --- /dev/null +++ b/docs/interfaces/destinyactivityloadoutrequirementset.html @@ -0,0 +1,200 @@ + + + + + + DestinyActivityLoadoutRequirementSet | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityLoadoutRequirementSet

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityLoadoutRequirementSet +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        requirements

        + + +
        +
        +

        The set of requirements that will be applied on the activity if this requirement + set is active.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitymatchmakingblockdefinition.html b/docs/interfaces/destinyactivitymatchmakingblockdefinition.html new file mode 100644 index 0000000..6413716 --- /dev/null +++ b/docs/interfaces/destinyactivitymatchmakingblockdefinition.html @@ -0,0 +1,283 @@ + + + + + + DestinyActivityMatchmakingBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityMatchmakingBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Information about matchmaking and party size for the activity.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityMatchmakingBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        isMatchmade

        +
        isMatchmade: boolean
        + +
        +
        +

        If TRUE, the activity is matchmade. Otherwise, it requires explicit forming of a + party.

        +
        +
        +
        +
        + +

        maxParty

        +
        maxParty: number
        + +
        +
        +

        The maximum # of people allowed in a Fireteam.

        +
        +
        +
        +
        + +

        maxPlayers

        +
        maxPlayers: number
        + +
        +
        +

        The maximum # of people allowed across all teams in the activity.

        +
        +
        +
        +
        + +

        minParty

        +
        minParty: number
        + +
        +
        +

        The minimum # of people in the fireteam for the activity to launch.

        +
        +
        +
        +
        + +

        requiresGuardianOath

        +
        requiresGuardianOath: boolean
        + +
        +
        +

        If true, you have to Solemnly Swear to be up to Nothing But Good(tm) to play.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitymodedefinition.html b/docs/interfaces/destinyactivitymodedefinition.html new file mode 100644 index 0000000..cf25d9d --- /dev/null +++ b/docs/interfaces/destinyactivitymodedefinition.html @@ -0,0 +1,486 @@ + + + + + + DestinyActivityModeDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityModeDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This definition represents an "Activity Mode" as it exists in the Historical + Stats endpoints. An individual Activity Mode represents a collection of + activities that are played in a certain way. For example, Nightfall Strikes are + part of a "Nightfall" activity mode, and any activities played as the PVP mode " + Clash" are part of the "Clash activity mode.

        +
        +

        Activity modes are nested under each other in a hierarchy, so that if you ask + for - for example - "AllPvP", you will get any PVP activities that the user has + played, regardless of what specific PVP mode was being played.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityModeDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activityModeCategory

        +
        activityModeCategory: DestinyActivityModeCategory
        + +
        +
        +

        The type of play being performed in broad terms (PVP, PVE)

        +
        +
        +
        +
        + +

        activityModeMappings

        +
        activityModeMappings: object
        + +
        +
        +

        If this exists, the mode has specific Activities (referred to by the Key) that + should instead map to other Activity Modes when they are played. This was useful + in D1 for Private Matches, where we wanted to have Private Matches as an + activity mode while still referring to the specific mode being played.

        +
        +
        +
        +

        Type declaration

        + +
        +
        +
        + +

        display

        +
        display: boolean
        + +
        +
        +

        If FALSE, we want to ignore this type when we're showing activity modes in BNet + UI. It will still be returned in case 3rd parties want to use it for any purpose.

        +
        +
        +
        +
        + +

        displayProperties

        + + +
        +
        + +

        friendlyName

        +
        friendlyName: string
        + +
        +
        +

        A Friendly identifier you can use for referring to this Activity Mode. We really + only used this in our URLs, so... you know, take that for whatever it's worth.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        isAggregateMode

        +
        isAggregateMode: boolean
        + +
        +
        +

        If true, this mode is an aggregation of other, more specific modes rather than + being a mode in itself. This includes modes that group Features/Events rather + than Gameplay, such as Trials of The Nine: Trials of the Nine being an Event + that is interesting to see aggregate data for, but when you play the activities + within Trials of the Nine they are more specific activity modes such as Clash.

        +
        +
        +
        +
        + +

        isTeamBased

        +
        isTeamBased: boolean
        + +
        +
        +

        If True, this mode has oppositional teams fighting against each other rather + than "Free-For-All" or Co-operative modes of play.

        +
        +

        Note that Aggregate modes are never marked as team based, even if they happen to + be team based at the moment. At any time, an aggregate whose subordinates are + only team based could be changed so that one or more aren't team based, and then + this boolean won't make much sense (the aggregation would become "sometimes team + based"). Let's not deal with that right now.

        +
        +
        +
        + +

        modeType

        + + +
        +
        +

        The Enumeration value for this Activity Mode. Pass this identifier into Stats + endpoints to get aggregate stats for this mode.

        +
        +
        +
        +
        + +

        order

        +
        order: number
        + +
        +
        +

        The relative ordering of activity modes.

        +
        +
        +
        +
        + +

        parentHashes

        +
        parentHashes: number[]
        + +
        +
        +

        The hash identifiers of the DestinyActivityModeDefinitions that represent all of + the "parent" modes for this mode. For instance, the Nightfall Mode is also a + member of AllStrikes and AllPvE.

        +
        +
        +
        +
        + +

        pgcrImage

        +
        pgcrImage: string
        + +
        +
        +

        If this activity mode has a related PGCR image, this will be the path to said + image.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitymodifierdefinition.html b/docs/interfaces/destinyactivitymodifierdefinition.html new file mode 100644 index 0000000..6d2c987 --- /dev/null +++ b/docs/interfaces/destinyactivitymodifierdefinition.html @@ -0,0 +1,263 @@ + + + + + + DestinyActivityModifierDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityModifierDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Modifiers - in Destiny 1, these were referred to as "Skulls" - are changes that + can be applied to an Activity.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityModifierDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitymodifierreferencedefinition.html b/docs/interfaces/destinyactivitymodifierreferencedefinition.html new file mode 100644 index 0000000..e7c4c71 --- /dev/null +++ b/docs/interfaces/destinyactivitymodifierreferencedefinition.html @@ -0,0 +1,210 @@ + + + + + + DestinyActivityModifierReferenceDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityModifierReferenceDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A reference to an Activity Modifier from another entity, such as an Activity ( + for now, just Activities).

        +
        +

        This defines some

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityModifierReferenceDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activityModifierHash

        +
        activityModifierHash: number
        + +
        +
        +

        The hash identifier for the DestinyActivityModifierDefinition referenced by this + activity.

        +
        +

        Mapped to DestinyActivityModifierDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivityplaylistitemdefinition.html b/docs/interfaces/destinyactivityplaylistitemdefinition.html new file mode 100644 index 0000000..63ecff3 --- /dev/null +++ b/docs/interfaces/destinyactivityplaylistitemdefinition.html @@ -0,0 +1,291 @@ + + + + + + DestinyActivityPlaylistItemDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityPlaylistItemDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If the activity is a playlist, this is the definition for a specific entry in + the playlist: a single possible combination of Activity and Activity Mode that + can be chosen.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityPlaylistItemDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activityHash

        +
        activityHash: number
        + +
        +
        +

        The hash identifier of the Activity that can be played. Use it to look up the + DestinyActivityDefinition.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        activityModeHashes

        +
        activityModeHashes: number[]
        + +
        +
        +

        The hash identifiers for Activity Modes relevant to this entry.

        +
        +

        Mapped to DestinyActivityModeDefinition in the manifest.

        +
        +
        +
        + +

        activityModeTypes

        +
        activityModeTypes: DestinyActivityModeType[]
        + +
        +
        +

        The activity modes - if any - in enum form. Because we can't seem to escape the + enums.

        +
        +
        +
        +
        + +

        Optional directActivityModeHash

        +
        directActivityModeHash: number
        + +
        +
        +

        If this playlist entry had an activity mode directly defined on it, this will be + the hash of that mode.

        +
        +

        Mapped to DestinyActivityModeDefinition in the manifest.

        +
        +
        +
        + +

        Optional directActivityModeType

        +
        directActivityModeType: number
        + +
        +
        +

        If the playlist entry had an activity mode directly defined on it, this will be + the enum value of that mode.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivityrewarddefinition.html b/docs/interfaces/destinyactivityrewarddefinition.html new file mode 100644 index 0000000..33ab35d --- /dev/null +++ b/docs/interfaces/destinyactivityrewarddefinition.html @@ -0,0 +1,237 @@ + + + + + + DestinyActivityRewardDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityRewardDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Activities can refer to one or more sets of tooltip-friendly reward data. These + are the definitions for those tooltip friendly rewards.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityRewardDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        rewardItems

        +
        rewardItems: DestinyItemQuantity[]
        + +
        +
        +

        The "Items provided" in the reward. This is almost always a pointer to a + DestinyInventoryItemDefintion for an item that you can't actually earn in-game, + but that has name/description/icon information for the vague concept of the + rewards you will receive. This is because the actual reward generation is non- + deterministic and extremely complicated, so the best the game can do is tell you + what you'll get in vague terms. And so too shall we.

        +
        +

        Interesting trivia: you actually do earn these items when you complete the + activity. They go into a single-slot bucket on your profile, which is how you + see the pop-ups of these rewards when you complete an activity that match these " + dummy" items. You can even see them if you look at the last one you earned in + your profile-level inventory through the BNet API! Who said reading + documentation is a waste of time?

        +
        +
        +
        + +

        rewardText

        +
        rewardText: string
        + +
        +
        +

        The header for the reward set, if any.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivitytypedefinition.html b/docs/interfaces/destinyactivitytypedefinition.html new file mode 100644 index 0000000..6d20abf --- /dev/null +++ b/docs/interfaces/destinyactivitytypedefinition.html @@ -0,0 +1,273 @@ + + + + + + DestinyActivityTypeDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityTypeDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The definition for an Activity Type.

        +
        +

        In Destiny 2, an Activity Type represents a conceptual categorization of + Activities.

        +

        These are most commonly used in the game for the subtitle under Activities, but + BNet uses them extensively to identify and group activities by their common + properties.

        +

        Unfortunately, there has been a movement away from providing the richer data in + Destiny 2 that we used to get in Destiny 1 for Activity Types. For instance, + Nightfalls are grouped under the same Activity Type as regular Strikes.

        +

        For this reason, BNet will eventually migrate toward Activity Modes as a better + indicator of activity category. But for the time being, it is still referred to + in many places across our codebase.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityTypeDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyactivityunlockstringdefinition.html b/docs/interfaces/destinyactivityunlockstringdefinition.html new file mode 100644 index 0000000..bbc6767 --- /dev/null +++ b/docs/interfaces/destinyactivityunlockstringdefinition.html @@ -0,0 +1,209 @@ + + + + + + DestinyActivityUnlockStringDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyActivityUnlockStringDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents a status string that could be conditionally displayed about an + activity. Note that externally, you can only see the strings themselves. + Internally we combine this information with server state to determine which + strings should be shown.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyActivityUnlockStringDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayString

        +
        displayString: string
        + +
        +
        +

        The string to be displayed if the conditions are met.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyaggregateactivityresults.html b/docs/interfaces/destinyaggregateactivityresults.html new file mode 100644 index 0000000..1926ea1 --- /dev/null +++ b/docs/interfaces/destinyaggregateactivityresults.html @@ -0,0 +1,199 @@ + + + + + + DestinyAggregateActivityResults | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyAggregateActivityResults

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyAggregateActivityResults +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activities

        + + +
        +
        +

        List of all activities the player has participated in.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyaggregateactivitystats.html b/docs/interfaces/destinyaggregateactivitystats.html new file mode 100644 index 0000000..44da58a --- /dev/null +++ b/docs/interfaces/destinyaggregateactivitystats.html @@ -0,0 +1,227 @@ + + + + + + DestinyAggregateActivityStats | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyAggregateActivityStats

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyAggregateActivityStats +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activityHash

        +
        activityHash: number
        + +
        +
        +

        Hash ID that can be looked up in the DestinyActivityTable.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        values

        +
        values: object
        + +
        +
        +

        Collection of stats for the player in this activity.

        +
        +
        +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyanimationreference.html b/docs/interfaces/destinyanimationreference.html new file mode 100644 index 0000000..154b5fe --- /dev/null +++ b/docs/interfaces/destinyanimationreference.html @@ -0,0 +1,222 @@ + + + + + + DestinyAnimationReference | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyAnimationReference

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyAnimationReference +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        animIdentifier

        +
        animIdentifier: string
        + +
        +
        + +

        animName

        +
        animName: string
        + +
        +
        + +

        path

        +
        path: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyartdyereference.html b/docs/interfaces/destinyartdyereference.html new file mode 100644 index 0000000..36f4d69 --- /dev/null +++ b/docs/interfaces/destinyartdyereference.html @@ -0,0 +1,194 @@ + + + + + + DestinyArtDyeReference | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyArtDyeReference

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyArtDyeReference +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        artDyeChannelHash

        +
        artDyeChannelHash: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinybaseitemcomponentsetofuint32.html b/docs/interfaces/destinybaseitemcomponentsetofuint32.html new file mode 100644 index 0000000..bd3eea7 --- /dev/null +++ b/docs/interfaces/destinybaseitemcomponentsetofuint32.html @@ -0,0 +1,194 @@ + + + + + + DestinyBaseItemComponentSetOfuint32 | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyBaseItemComponentSetOfuint32

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyBaseItemComponentSetOfuint32 +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        objectives

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinybubbledefinition.html b/docs/interfaces/destinybubbledefinition.html new file mode 100644 index 0000000..0932b96 --- /dev/null +++ b/docs/interfaces/destinybubbledefinition.html @@ -0,0 +1,229 @@ + + + + + + DestinyBubbleDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyBubbleDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Basic identifying data about the bubble. Combine with + DestinyDestinationBubbleSettingDefinition - see DestinyDestinationDefinition. + bubbleSettings for more information.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyBubbleDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        +

        The display properties of this bubble, so you don't have to look them up in a + separate list anymore.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The identifier for the bubble: only guaranteed to be unique within the + Destination.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinychallengestatus.html b/docs/interfaces/destinychallengestatus.html new file mode 100644 index 0000000..29dc2c0 --- /dev/null +++ b/docs/interfaces/destinychallengestatus.html @@ -0,0 +1,209 @@ + + + + + + DestinyChallengeStatus | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyChallengeStatus

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents the status and other related information for a challenge that is - or + was - available to a player.

        +
        +

        A challenge is a bonus objective, generally tacked onto Quests or Activities, + that provide additional variations on play.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyChallengeStatus +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        objective

        + + +
        +
        +

        The progress - including completion status - of the active challenge.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinycharacteractivitiescomponent.html b/docs/interfaces/destinycharacteractivitiescomponent.html new file mode 100644 index 0000000..b85b914 --- /dev/null +++ b/docs/interfaces/destinycharacteractivitiescomponent.html @@ -0,0 +1,376 @@ + + + + + + DestinyCharacterActivitiesComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyCharacterActivitiesComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This component holds activity data for a character. It will tell you about the + character's current activity status, as well as activities that are available to + the user.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyCharacterActivitiesComponent +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        availableActivities

        +
        availableActivities: DestinyActivity[]
        + +
        +
        +

        The list of activities that the user can play.

        +
        +
        +
        +
        + +

        currentActivityHash

        +
        currentActivityHash: number
        + +
        +
        +

        If the user is in an activity, this will be the hash of the Activity being + played. Note that you must combine this info with currentActivityModeHash to get + a real picture of what the user is doing right now. For instance, PVP " + Activities" are just maps: it's the ActivityMode that determines what type of + PVP game they're playing.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        currentActivityModeHash

        +
        currentActivityModeHash: number
        + +
        +
        +

        If the user is in an activity, this will be the hash of the activity mode being + played. Combine with currentActivityHash to give a person a full picture of what + they're doing right now.

        +
        +

        Mapped to DestinyActivityModeDefinition in the manifest.

        +
        +
        +
        + +

        currentActivityModeHashes

        +
        currentActivityModeHashes: number[]
        + +
        +
        +

        If the user is in an activity, this will be the hashes of the + DestinyActivityModeDefinition being played. Combine with currentActivityHash to + give a person a full picture of what they're doing right now.

        +
        +

        Mapped to DestinyActivityModeDefinition in the manifest.

        +
        +
        +
        + +

        Optional currentActivityModeType

        +
        currentActivityModeType: number
        + +
        +
        +

        And the current activity's most specific mode type, if it can be found.

        +
        +

        Mapped to DestinyActivityModeDefinition in the manifest.

        +
        +
        +
        + +

        currentActivityModeTypes

        +
        currentActivityModeTypes: DestinyActivityModeType[]
        + +
        +
        +

        All Activity Modes that apply to the current activity being played, in enum form.

        +
        +
        +
        +
        + +

        Optional currentPlaylistActivityHash

        +
        currentPlaylistActivityHash: number
        + +
        +
        +

        If the user is in a playlist, this is the hash identifier for the playlist that + they chose.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        dateActivityStarted

        +
        dateActivityStarted: string
        + +
        +
        +

        The last date that the user started playing an activity.

        +
        +
        +
        +
        + +

        lastCompletedStoryHash

        +
        lastCompletedStoryHash: number
        + +
        +
        +

        This will have the activity hash of the last completed story/campaign mission, + in case you care about that.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinycharactercomponent.html b/docs/interfaces/destinycharactercomponent.html new file mode 100644 index 0000000..363d8e0 --- /dev/null +++ b/docs/interfaces/destinycharactercomponent.html @@ -0,0 +1,648 @@ + + + + + + DestinyCharacterComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyCharacterComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This component contains base properties of the character. You'll probably want + to always request this component, but hey you do you.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyCharacterComponent +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        baseCharacterLevel

        +
        baseCharacterLevel: number
        + +
        +
        +

        The "base" level of your character, not accounting for any light level.

        +
        +
        +
        +
        + +

        characterId

        +
        characterId: string
        + +
        +
        +

        The unique identifier for the character.

        +
        +
        +
        +
        + +

        classHash

        +
        classHash: number
        + +
        +
        +

        Use this hash to look up the character's DestinyClassDefinition.

        +
        +

        Mapped to DestinyClassDefinition in the manifest.

        +
        +
        +
        + +

        classType

        +
        classType: DestinyClass
        + +
        +
        +

        Mostly for historical purposes at this point, this is an enumeration for the + character's class.

        +
        +

        It'll be preferable in the general case to look up the related definition: but + for some people this was too convenient to remove.

        +
        +
        +
        + +

        dateLastPlayed

        +
        dateLastPlayed: string
        + +
        +
        +

        The last date that the user played Destiny.

        +
        +
        +
        +
        + +

        emblemBackgroundPath

        +
        emblemBackgroundPath: string
        + +
        +
        +

        A shortcut path to the user's currently equipped emblem background image. If you' + re just showing summary info for a user, this is more convenient than examining + their equipped emblem and looking up the definition.

        +
        +
        +
        +
        + +

        emblemColor

        +
        emblemColor: DestinyColor
        + +
        +
        +

        A shortcut for getting the background color of the user's currently equipped + emblem without having to do a DestinyInventoryItemDefinition lookup.

        +
        +
        +
        +
        + +

        emblemHash

        +
        emblemHash: number
        + +
        +
        +

        The hash of the currently equipped emblem for the user. Can be used to look up + the DestinyInventoryItemDefinition.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        emblemPath

        +
        emblemPath: string
        + +
        +
        +

        A shortcut path to the user's currently equipped emblem image. If you're just + showing summary info for a user, this is more convenient than examining their + equipped emblem and looking up the definition.

        +
        +
        +
        +
        + +

        genderHash

        +
        genderHash: number
        + +
        +
        +

        Use this hash to look up the character's DestinyGenderDefinition.

        +
        +

        Mapped to DestinyGenderDefinition in the manifest.

        +
        +
        +
        + +

        genderType

        +
        genderType: DestinyGender
        + +
        +
        +

        Mostly for historical purposes at this point, this is an enumeration for the + character's Gender.

        +
        +

        It'll be preferable in the general case to look up the related definition: but + for some people this was too convenient to remove. And yeah, it's an enumeration + and not a boolean. Fight me.

        +
        +
        +
        + +

        levelProgression

        +
        levelProgression: DestinyProgression
        + +
        +
        +

        The progression that indicates your character's level. Not their light level, + but their character level: you know, the thing you max out a couple hours in and + then ignore for the sake of light level.

        +
        +
        +
        +
        + +

        light

        +
        light: number
        + +
        +
        +

        The user's calculated "Light Level". Light level is an indicator of your power + that mostly matters in the end game, once you've reached the maximum character + level: it's a level that's dependent on the average Attack/Defense power of your + items.

        +
        +
        +
        +
        + +

        membershipId

        +
        membershipId: string
        + +
        +
        +

        Every Destiny Profile has a membershipId. This is provided on the character as + well for convenience.

        +
        +
        +
        +
        + +

        membershipType

        +
        membershipType: BungieMembershipType
        + +
        +
        +

        membershipType tells you the platform on which the character plays. Examine the + BungieMembershipType enumeration for possible values.

        +
        +
        +
        +
        + +

        minutesPlayedThisSession

        +
        minutesPlayedThisSession: string
        + +
        +
        +

        If the user is currently playing, this is how long they've been playing.

        +
        +
        +
        +
        + +

        minutesPlayedTotal

        +
        minutesPlayedTotal: string
        + +
        +
        +

        If this value is 525,600, then they played Destiny for a year. Or they're a very + dedicated Rent fan. Note that this includes idle time, not just time spent + actually in activities shooting things.

        +
        +
        +
        +
        + +

        percentToNextLevel

        +
        percentToNextLevel: number
        + +
        +
        +

        A number between 0 and 100, indicating the whole and fractional % remaining to + get to the next character level.

        +
        +
        +
        +
        + +

        raceHash

        +
        raceHash: number
        + +
        +
        +

        Use this hash to look up the character's DestinyRaceDefinition.

        +
        +

        Mapped to DestinyRaceDefinition in the manifest.

        +
        +
        +
        + +

        raceType

        +
        raceType: DestinyRace
        + +
        +
        +

        Mostly for historical purposes at this point, this is an enumeration for the + character's race.

        +
        +

        It'll be preferable in the general case to look up the related definition: but + for some people this was too convenient to remove.

        +
        +
        +
        + +

        stats

        +
        stats: object
        + +
        +
        +

        Your character's stats, such as Agility, Resilience, etc... not historical + stats.

        +
        +

        You'll have to call a different endpoint for those.

        +
        +
        +

        Type declaration

        +
          +
        • +
          [key: number]: number
          +
        • +
        +
        +
        +
        + +

        Optional titleRecordHash

        +
        titleRecordHash: number
        + +
        +
        +

        If this Character has a title assigned to it, this is the identifier of the + DestinyRecordDefinition that has that title information.

        +
        +

        Mapped to DestinyRecordDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinycharactercustomization.html b/docs/interfaces/destinycharactercustomization.html new file mode 100644 index 0000000..6a4d3bd --- /dev/null +++ b/docs/interfaces/destinycharactercustomization.html @@ -0,0 +1,362 @@ + + + + + + DestinyCharacterCustomization | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyCharacterCustomization

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Raw data about the customization options chosen for a character's face and + appearance.

        +
        +

        You can look up the relevant class/race/gender combo in + DestinyCharacterCustomizationOptionDefinition for the character, and then look + up these values within the CustomizationOptions found to pull some data about + their choices. Warning: not all of that data is meaningful. Some data has useful + icons. Others have nothing, and are only meant for 3D rendering purposes (which + we sadly do not expose yet)

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyCharacterCustomization +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        decalColor

        +
        decalColor: number
        + +
        +
        + +

        decalIndex

        +
        decalIndex: number
        + +
        +
        + +

        eyeColor

        +
        eyeColor: number
        + +
        +
        + +

        face

        +
        face: number
        + +
        +
        + +

        featureColors

        +
        featureColors: number[]
        + +
        +
        + +

        featureIndex

        +
        featureIndex: number
        + +
        +
        + +

        hairColors

        +
        hairColors: number[]
        + +
        +
        + +

        hairIndex

        +
        hairIndex: number
        + +
        +
        + +

        lipColor

        +
        lipColor: number
        + +
        +
        + +

        personality

        +
        personality: number
        + +
        +
        + +

        skinColor

        +
        skinColor: number
        + +
        +
        + +

        wearHelmet

        +
        wearHelmet: boolean
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinycharacterpeerview.html b/docs/interfaces/destinycharacterpeerview.html new file mode 100644 index 0000000..7465cab --- /dev/null +++ b/docs/interfaces/destinycharacterpeerview.html @@ -0,0 +1,202 @@ + + + + + + DestinyCharacterPeerView | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyCharacterPeerView

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A minimal view of a character's equipped items, for the purpose of rendering a + summary screen or showing the character in 3D.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyCharacterPeerView +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        equipment

        +
        equipment: DestinyItemPeerView[]
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinycharacterprogressioncomponent.html b/docs/interfaces/destinycharacterprogressioncomponent.html new file mode 100644 index 0000000..f283273 --- /dev/null +++ b/docs/interfaces/destinycharacterprogressioncomponent.html @@ -0,0 +1,369 @@ + + + + + + DestinyCharacterProgressionComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyCharacterProgressionComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This component returns anything that could be considered "Progression" on a user: + data where the user is gaining levels, reputation, completions, rewards, etc...

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyCharacterProgressionComponent +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        checklists

        +
        checklists: object
        + +
        +
        +

        The set of checklists that can be examined for this specific character, keyed by + the hash identifier of the Checklist (DestinyChecklistDefinition)

        +
        +

        For each checklist returned, its value is itself a Dictionary keyed by the + checklist's hash identifier with the value being a boolean indicating if it's + been discovered yet.

        +

        Mapped to DestinyChecklistDefinition in the manifest.

        +
        +
        +

        Type declaration

        +
          +
        • +
          [key: number]: object
          +
            +
          • +
            [key: number]: boolean
            +
          • +
          +
        • +
        +
        +
        +
        + +

        factions

        +
        factions: object
        + +
        +
        +

        A dictionary of all known Factions, keyed by the Faction's hash. It contains + data about this character's status with the faction.

        +
        +

        Mapped to DestinyFactionDefinition in the manifest.

        +
        +
        +

        Type declaration

        + +
        +
        +
        + +

        milestones

        +
        milestones: object
        + +
        +
        +

        Milestones are related to the simple progressions shown in the game, but return + additional and hopefully helpful information for users about the specifics of + the Milestone's status.

        +
        +

        Mapped to DestinyMilestoneDefinition in the manifest.

        +
        +
        +

        Type declaration

        + +
        +
        +
        + +

        progressions

        +
        progressions: object
        + +
        +
        +

        A Dictionary of all known progressions for the Character, keyed by the + Progression's hash.

        +
        +

        Not all progressions have user-facing data, but those who do will have that data + contained in the DestinyProgressionDefinition.

        +

        Mapped to DestinyProgressionDefinition in the manifest.

        +
        +
        +

        Type declaration

        + +
        +
        +
        + +

        quests

        + + +
        +
        +

        If the user has any active quests, the quests' statuses will be returned here.

        +
        +

        Note that quests have been largely supplanted by Milestones, but that doesn't + mean that they won't make a comeback independent of milestones at some point.

        +
        +
        +
        + +

        uninstancedItemObjectives

        +
        uninstancedItemObjectives: object
        + +
        +
        +

        Sometimes, you have items in your inventory that don't have instances, but still + have Objective information. This provides you that objective information for + uninstanced items.

        +
        +

        This dictionary is keyed by the item's hash: which you can use to look up the + name and description for the overall task(s) implied by the objective. The value + is the list of objectives for this item, and their statuses.

        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinycharacterrecordscomponent.html b/docs/interfaces/destinycharacterrecordscomponent.html new file mode 100644 index 0000000..1612ab2 --- /dev/null +++ b/docs/interfaces/destinycharacterrecordscomponent.html @@ -0,0 +1,221 @@ + + + + + + DestinyCharacterRecordsComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyCharacterRecordsComponent

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyCharacterRecordsComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        featuredRecordHashes

        +
        featuredRecordHashes: number[]
        + +
        +
        +

        Mapped to DestinyRecordDefinition in the manifest.

        +
        +
        +
        +
        + +

        records

        +
        records: object
        + +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinycharacterrendercomponent.html b/docs/interfaces/destinycharacterrendercomponent.html new file mode 100644 index 0000000..912c316 --- /dev/null +++ b/docs/interfaces/destinycharacterrendercomponent.html @@ -0,0 +1,263 @@ + + + + + + DestinyCharacterRenderComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyCharacterRenderComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Only really useful if you're attempting to render the character's current + appearance in 3D, this returns a bare minimum of information, pre-aggregated, + that you'll need to perform that rendering. Note that you need to combine this + with other 3D assets and data from our servers.

        +
        +

        Examine the Javascript returned by https://bungie.net/sharedbundle/spasm to see + how we use this data, but be warned: the rabbit hole goes pretty deep.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyCharacterRenderComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        customDyes

        +
        customDyes: DyeReference[]
        + +
        +
        +

        Custom dyes, calculated by iterating over the character's equipped items. Useful + for pre-fetching all of the dye data needed from our server.

        +
        +
        +
        +
        + +

        customization

        + + +
        +
        +

        This is actually something that Spasm.js doesn't do right now, and that we don' + t return assets for yet. This is the data about what character customization + options you picked. You can combine this with + DestinyCharacterCustomizationOptionDefinition to show some cool info, and + hopefully someday to actually render a user's face in 3D. We'll see if we ever + end up with time for that.

        +
        +
        +
        +
        + +

        peerView

        + + +
        +
        +

        A minimal view of:

        +
        +
          +
        • Equipped items

          +
        • +
        • The rendering-related custom options on those equipped items

          +
        • +
        +

        Combined, that should be enough to render all of the items on the equipped + character.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinycharacterresponse.html b/docs/interfaces/destinycharacterresponse.html new file mode 100644 index 0000000..0318a4e --- /dev/null +++ b/docs/interfaces/destinycharacterresponse.html @@ -0,0 +1,474 @@ + + + + + + DestinyCharacterResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyCharacterResponse

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The response contract for GetDestinyCharacter, with components that can be + returned for character and item-level data.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyCharacterResponse +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activities

        + + +
        +
        +

        Activity data - info about current activities available to the player.

        +
        +

        COMPONENT TYPE: CharacterActivities

        +
        +
        +
        + +

        character

        + + +
        +
        +

        Base information about the character in question.

        +
        +

        COMPONENT TYPE: Characters

        +
        +
        +
        + +

        collectibles

        + + +
        +
        +

        COMPONENT TYPE: Collectibles

        +
        +
        +
        +
        + +

        currencyLookups

        + + +
        +
        +

        A "lookup" convenience component that can be used to quickly check if the + character has access to items that can be used for purchasing.

        +
        +

        COMPONENT TYPE: CurrencyLookups

        +
        +
        +
        + +

        equipment

        + + +
        +
        +

        Equipped items on the character.

        +
        +

        COMPONENT TYPE: CharacterEquipment

        +
        +
        +
        + +

        inventory

        + + +
        +
        +

        The character-level non-equipped inventory items.

        +
        +

        COMPONENT TYPE: CharacterInventories

        +
        +
        +
        + +

        itemComponents

        + + +
        +
        +

        The set of components belonging to the player's instanced items.

        +
        +

        COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component + types.]

        +
        +
        +
        + +

        kiosks

        + + +
        +
        +

        Items available from Kiosks that are available to this specific character.

        +
        +

        COMPONENT TYPE: Kiosks

        +
        +
        +
        + +

        plugSets

        + + +
        +
        +

        When sockets refer to reusable Plug Sets (see DestinyPlugSetDefinition for more + info), this is the set of plugs and their states that are scoped to this + character.

        +
        +

        This comes back with ItemSockets, as it is needed for a complete picture of the + sockets on requested items.

        +

        COMPONENT TYPE: ItemSockets

        +
        +
        +
        + +

        presentationNodes

        + + +
        +
        +

        COMPONENT TYPE: PresentationNodes

        +
        +
        +
        +
        + +

        progressions

        + + +
        +
        +

        Character progression data, including Milestones.

        +
        +

        COMPONENT TYPE: CharacterProgressions

        +
        +
        +
        + +

        records

        + + +
        +
        +

        COMPONENT TYPE: Records

        +
        +
        +
        +
        + +

        renderData

        + + +
        +
        +

        Character rendering data - a minimal set of information about equipment and dyes + used for rendering.

        +
        +

        COMPONENT TYPE: CharacterRenderData

        +
        +
        +
        + +

        uninstancedItemComponents

        +
        uninstancedItemComponents: DestinyBaseItemComponentSetOfuint32
        + +
        +
        +

        The set of components belonging to the player's UNinstanced items. Because + apparently now those too can have information relevant to the character's state.

        +
        +

        COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component + types.]

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinychecklistdefinition.html b/docs/interfaces/destinychecklistdefinition.html new file mode 100644 index 0000000..a532d50 --- /dev/null +++ b/docs/interfaces/destinychecklistdefinition.html @@ -0,0 +1,335 @@ + + + + + + DestinyChecklistDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyChecklistDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        By public demand, Checklists are loose sets of "things to do/things you have + done" in Destiny that we were actually able to track. They include easter eggs + you find in the world, unique chests you unlock, and other such data where the + first time you do it is significant enough to be tracked, and you have the + potential to "get them all".

        +
        +

        These may be account-wide, or may be per character. The status of these will be + returned in related "Checklist" data coming down from API requests such as + GetProfile or GetCharacter.

        +

        Generally speaking, the items in a checklist can be completed in any order: we + return an ordered list which only implies the way we are showing them in our own + UI, and you can feel free to alter it as you wish.

        +

        Note that, in the future, there will be something resembling the old D1 Record + Books in at least some vague form. When that is created, it may be that it will + supercede much or all of this Checklist data. It remains to be seen if that will + be the case, so for now assume that the Checklists will still exist even after + the release of D2: Forsaken.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyChecklistDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        + +

        entries

        + + +
        +
        +

        The individual checklist items. Gotta catch 'em all.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        scope

        + + +
        +
        +

        Indicates whether you will find this checklist on the Profile or Character + components.

        +
        +
        +
        +
        + +

        viewActionString

        +
        viewActionString: string
        + +
        +
        +

        A localized string prompting you to view the checklist.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinychecklistentrydefinition.html b/docs/interfaces/destinychecklistentrydefinition.html new file mode 100644 index 0000000..c431b25 --- /dev/null +++ b/docs/interfaces/destinychecklistentrydefinition.html @@ -0,0 +1,380 @@ + + + + + + DestinyChecklistEntryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyChecklistEntryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The properties of an individual checklist item. Note that almost everything is + optional: it is highly variable what kind of data we'll actually be able to + return: at times we may have no other relationships to entities at all.

        +
        +

        Whatever UI you build, do it with the knowledge that any given entry might not + actually be able to be associated with some other Destiny entity.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyChecklistEntryDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        Optional activityHash

        +
        activityHash: number
        + +
        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        +
        + +

        Optional bubbleHash

        +
        bubbleHash: number
        + +
        +
        +

        Note that a Bubble's hash doesn't uniquely identify a "top level" entity in + Destiny. Only the combination of location and bubble can uniquely identify a + place in the world of Destiny: so if bubbleHash is populated, locationHash must + too be populated for it to have any meaning.

        +
        +

        You can use this property if it is populated to look up the + DestinyLocationDefinition's associated .locationReleases[].activityBubbleName + property.

        +
        +
        +
        + +

        Optional destinationHash

        +
        destinationHash: number
        + +
        +
        +

        Mapped to DestinyDestinationDefinition in the manifest.

        +
        +
        +
        +
        + +

        displayProperties

        + + +
        +
        +

        Even if no other associations exist, we will give you something for display + properties. In cases where we have no associated entities, it may be as simple + as a numerical identifier.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The identifier for this Checklist entry. Guaranteed unique only within this + Checklist Definition, and not globally/for all checklists.

        +
        +
        +
        +
        + +

        Optional itemHash

        +
        itemHash: number
        + +
        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        +
        + +

        Optional locationHash

        +
        locationHash: number
        + +
        +
        +

        Mapped to DestinyLocationDefinition in the manifest.

        +
        +
        +
        +
        + +

        scope

        + + +
        +
        +

        The scope at which this specific entry can be computed.

        +
        +
        +
        +
        + +

        Optional vendorHash

        +
        vendorHash: number
        + +
        +
        + +

        Optional vendorInteractionIndex

        +
        vendorInteractionIndex: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyclanaggregatestat.html b/docs/interfaces/destinyclanaggregatestat.html new file mode 100644 index 0000000..9664b22 --- /dev/null +++ b/docs/interfaces/destinyclanaggregatestat.html @@ -0,0 +1,237 @@ + + + + + + DestinyClanAggregateStat | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyClanAggregateStat

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyClanAggregateStat +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        mode

        + + +
        +
        +

        The id of the mode of stats (allPvp, allPvE, etc)

        +
        +
        +
        +
        + +

        statId

        +
        statId: string
        + +
        +
        +

        The id of the stat

        +
        +
        +
        +
        + +

        value

        + + +
        +
        +

        Value of the stat for this player

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyclassdefinition.html b/docs/interfaces/destinyclassdefinition.html new file mode 100644 index 0000000..67fcdff --- /dev/null +++ b/docs/interfaces/destinyclassdefinition.html @@ -0,0 +1,356 @@ + + + + + + DestinyClassDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyClassDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Defines a Character Class in Destiny 2. These are types of characters you can + play, like Titan, Warlock, and Hunter.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyClassDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        classType

        +
        classType: DestinyClass
        + +
        +
        +

        In Destiny 1, we added a convenience Enumeration for referring to classes. We've + kept it, though mostly for posterity. This is the enum value for this definition' + s class.

        +
        +
        +
        +
        + +

        displayProperties

        + + +
        +
        + +

        genderedClassNames

        +
        genderedClassNames: object
        + +
        +
        +

        A localized string referring to the singular form of the Class's name when + referred to in gendered form. Keyed by the DestinyGender.

        +
        +
        +
        +

        Type declaration

        +
          +
        +
        +
        +
        + +

        genderedClassNamesByGenderHash

        +
        genderedClassNamesByGenderHash: object
        + +
        +
        +

        Mapped to DestinyGenderDefinition in the manifest.

        +
        +
        +
        +

        Type declaration

        +
          +
        • +
          [key: number]: string
          +
        • +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        Optional mentorVendorHash

        +
        mentorVendorHash: number
        + +
        +
        +

        Mentors don't really mean anything anymore. Don't expect this to be populated.

        +
        +

        Mapped to DestinyVendorDefinition in the manifest.

        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinycollectibleacquisitionblock.html b/docs/interfaces/destinycollectibleacquisitionblock.html new file mode 100644 index 0000000..ec277ac --- /dev/null +++ b/docs/interfaces/destinycollectibleacquisitionblock.html @@ -0,0 +1,218 @@ + + + + + + DestinyCollectibleAcquisitionBlock | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyCollectibleAcquisitionBlock

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyCollectibleAcquisitionBlock +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        Optional acquireMaterialRequirementHash

        +
        acquireMaterialRequirementHash: number
        + +
        +
        +

        Mapped to DestinyMaterialRequirementSetDefinition in the manifest.

        +
        +
        +
        +
        + +

        Optional acquireTimestampUnlockValueHash

        +
        acquireTimestampUnlockValueHash: number
        + +
        +
        +

        Mapped to DestinyUnlockValueDefinition in the manifest.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinycollectiblecomponent.html b/docs/interfaces/destinycollectiblecomponent.html new file mode 100644 index 0000000..308f2a1 --- /dev/null +++ b/docs/interfaces/destinycollectiblecomponent.html @@ -0,0 +1,200 @@ + + + + + + DestinyCollectibleComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyCollectibleComponent

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyCollectibleComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        state

        + + +
        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinycollectibledefinition.html b/docs/interfaces/destinycollectibledefinition.html new file mode 100644 index 0000000..86f6408 --- /dev/null +++ b/docs/interfaces/destinycollectibledefinition.html @@ -0,0 +1,387 @@ + + + + + + DestinyCollectibleDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyCollectibleDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Defines a

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyCollectibleDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        acquisitionInfo

        + + +
        +
        + +

        displayProperties

        + + +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        itemHash

        +
        itemHash: number
        + +
        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        +
        + +

        presentationInfo

        + + +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        scope

        + + +
        +
        +

        Indicates whether this Collectible's state is determined on a per-character or + on an account-wide basis.

        +
        +
        +
        +
        + +

        Optional sourceHash

        +
        sourceHash: number
        + +
        +
        +

        This is a hash identifier we are building on the BNet side in an attempt to let + people group collectibles by similar sources.

        +
        +

        I can't promise that it's going to be 100% accurate, but if the designers were + consistent in assigning the same source strings to items with the same sources, + it ought to be. No promises though.

        +

        This hash also doesn't relate to an actual definition, just to note: we've got + nothing useful other than the source string for this data.

        +
        +
        +
        + +

        sourceString

        +
        sourceString: string
        + +
        +
        +

        A human readable string for a hint about how to acquire the item.

        +
        +
        +
        +
        + +

        stateInfo

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinycollectiblenodedetailresponse.html b/docs/interfaces/destinycollectiblenodedetailresponse.html new file mode 100644 index 0000000..30b01bc --- /dev/null +++ b/docs/interfaces/destinycollectiblenodedetailresponse.html @@ -0,0 +1,238 @@ + + + + + + DestinyCollectibleNodeDetailResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyCollectibleNodeDetailResponse

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Returns the detailed information about a Collectible Presentation Node and any + Collectibles that are direct descendants.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyCollectibleNodeDetailResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        collectibleItemComponents

        +
        collectibleItemComponents: DestinyItemComponentSetOfuint32
        + +
        +
        +

        Item components, keyed by the item hash of the items pointed at collectibles + found under the requested Presentation Node.

        +
        +

        NOTE: I had a lot of hemming and hawing about whether these should be keyed by + collectible hash or item hash... but ultimately having it be keyed by item hash + meant that UI that already uses DestinyItemComponentSet data wouldn't have to + have a special override to do the collectible -> item lookup once you delve into + an item's details, and it also meant that you didn't have to remember that the + Hash being used as the key for plugSets was different from the Hash being used + for the other Dictionaries. As a result, using the Item Hash felt like the least + crappy solution.

        +

        We may all come to regret this decision. We will see.

        +

        COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component + types.]

        +
        +
        +
        + +

        collectibles

        + + +
        +
        +

        COMPONENT TYPE: Collectibles

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinycollectiblescomponent.html b/docs/interfaces/destinycollectiblescomponent.html new file mode 100644 index 0000000..027abab --- /dev/null +++ b/docs/interfaces/destinycollectiblescomponent.html @@ -0,0 +1,202 @@ + + + + + + DestinyCollectiblesComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyCollectiblesComponent

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyCollectiblesComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        collectibles

        +
        collectibles: object
        + +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinycollectiblestateblock.html b/docs/interfaces/destinycollectiblestateblock.html new file mode 100644 index 0000000..e074b86 --- /dev/null +++ b/docs/interfaces/destinycollectiblestateblock.html @@ -0,0 +1,213 @@ + + + + + + DestinyCollectibleStateBlock | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyCollectibleStateBlock

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyCollectibleStateBlock +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        Optional obscuredOverrideItemHash

        +
        obscuredOverrideItemHash: number
        + +
        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        +
        + +

        requirements

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinycolor.html b/docs/interfaces/destinycolor.html new file mode 100644 index 0000000..3a7056c --- /dev/null +++ b/docs/interfaces/destinycolor.html @@ -0,0 +1,244 @@ + + + + + + DestinyColor | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyColor

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents a color whose RGBA values are all represented as values between 0 and + 255.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyColor +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        alpha

        +
        alpha: number
        + +
        +
        + +

        blue

        +
        blue: number
        + +
        +
        + +

        green

        +
        green: number
        + +
        +
        + +

        red

        +
        red: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinycurrenciescomponent.html b/docs/interfaces/destinycurrenciescomponent.html new file mode 100644 index 0000000..378c34e --- /dev/null +++ b/docs/interfaces/destinycurrenciescomponent.html @@ -0,0 +1,228 @@ + + + + + + DestinyCurrenciesComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyCurrenciesComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This component provides a quick lookup of every item the requested character has + and how much of that item they have.

        +
        +

        Requesting this component will allow you to circumvent manually putting together + the list of which currencies you have for the purpose of testing currency + requirements on an item being purchased, or operations that have costs.

        +

        You could figure this out yourself by doing a GetCharacter or GetProfile + request and forming your own lookup table, but that is inconvenient enough that + this feels like a worthwhile (and optional) redundency. Don't bother requesting + it if you have already created your own lookup from prior GetCharacter/ + GetProfile calls.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyCurrenciesComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        itemQuantities

        +
        itemQuantities: object
        + +
        +
        +

        A dictionary - keyed by the item's hash identifier ( + DestinyInventoryItemDefinition), and whose value is the amount of that item you + have across all available inventory buckets for purchasing.

        +
        +

        This allows you to see whether the requesting character can afford any given + purchase/action without having to re-create this list itself.

        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +

        Type declaration

        +
          +
        • +
          [key: number]: number
          +
        • +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinydamagetypedefinition.html b/docs/interfaces/destinydamagetypedefinition.html new file mode 100644 index 0000000..7306eef --- /dev/null +++ b/docs/interfaces/destinydamagetypedefinition.html @@ -0,0 +1,327 @@ + + + + + + DestinyDamageTypeDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyDamageTypeDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        All damage types that are possible in the game are defined here, along with + localized info and icons as needed.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyDamageTypeDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        +

        The description of the damage type, icon etc...

        +
        +
        +
        +
        + +

        enumValue

        +
        enumValue: DamageType
        + +
        +
        +

        We have an enumeration for damage types for quick reference. This is the current + definition's damage type enum value.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        showIcon

        +
        showIcon: boolean
        + +
        +
        +

        If TRUE, the game shows this damage type's icon. Otherwise, it doesn't. Whether + you show it or not is up to you.

        +
        +
        +
        +
        + +

        transparentIconPath

        +
        transparentIconPath: string
        + +
        +
        +

        A variant of the icon that is transparent and colorless.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinydefinition.html b/docs/interfaces/destinydefinition.html new file mode 100644 index 0000000..03bc261 --- /dev/null +++ b/docs/interfaces/destinydefinition.html @@ -0,0 +1,248 @@ + + + + + + DestinyDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Provides common properties for destiny definitions.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyderiveditemcategorydefinition.html b/docs/interfaces/destinyderiveditemcategorydefinition.html new file mode 100644 index 0000000..3b71795 --- /dev/null +++ b/docs/interfaces/destinyderiveditemcategorydefinition.html @@ -0,0 +1,236 @@ + + + + + + DestinyDerivedItemCategoryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyDerivedItemCategoryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A shortcut for the fact that some items have a "Preview Vendor" - See + DestinyInventoryItemDefinition.preview.previewVendorHash - that is intended to + be used to show what items you can get as a result of acquiring or using this + item.

        +
        +

        A common example of this in Destiny 1 was Eververse "Boxes," which could have + many possible items. This "Preview Vendor" is not a vendor you can actually see + in the game, but it defines categories and sale items for all of the possible + items you could get from the Box so that the game can show them to you. We + summarize that info here so that you don't have to do that Vendor lookup and + aggregation manually.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyDerivedItemCategoryDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        categoryDescription

        +
        categoryDescription: string
        + +
        +
        +

        The localized string for the category title. This will be something describing + the items you can get as a group, or your likelihood/the quantity you'll get.

        +
        +
        +
        +
        + +

        items

        + + +
        +
        +

        This is the list of all of the items for this category and the basic properties + we'll know about them.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyderiveditemdefinition.html b/docs/interfaces/destinyderiveditemdefinition.html new file mode 100644 index 0000000..1f4b3cc --- /dev/null +++ b/docs/interfaces/destinyderiveditemdefinition.html @@ -0,0 +1,308 @@ + + + + + + DestinyDerivedItemDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyDerivedItemDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This is a reference to, and summary data for, a specific item that you can get + as a result of Using or Acquiring some other Item (For example, this could be + summary information for an Emote that you can get by opening an an Eververse Box) + See DestinyDerivedItemCategoryDefinition for more information.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyDerivedItemDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        iconPath

        +
        iconPath: string
        + +
        +
        +

        An icon for the item.

        +
        +
        +
        +
        + +

        itemDescription

        +
        itemDescription: string
        + +
        +
        +

        A brief description of the item.

        +
        +
        +
        +
        + +

        itemDetail

        +
        itemDetail: string
        + +
        +
        +

        Additional details about the derived item, in addition to the description.

        +
        +
        +
        +
        + +

        Optional itemHash

        +
        itemHash: number
        + +
        +
        +

        The hash for the DestinyInventoryItemDefinition of this derived item, if there + is one. Sometimes we are given this information as a manual override, in which + case there won't be an actual DestinyInventoryItemDefinition for what we display, + but you can still show the strings from this object itself.

        +
        +
        +
        +
        + +

        itemName

        +
        itemName: string
        + +
        +
        +

        The name of the derived item.

        +
        +
        +
        +
        + +

        vendorItemIndex

        +
        vendorItemIndex: number
        + +
        +
        +

        If the item was derived from a "Preview Vendor", this will be an index into the + DestinyVendorDefinition's itemList property. Otherwise, -1.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinydestinationbubblesettingdefinition.html b/docs/interfaces/destinydestinationbubblesettingdefinition.html new file mode 100644 index 0000000..d4fc7a9 --- /dev/null +++ b/docs/interfaces/destinydestinationbubblesettingdefinition.html @@ -0,0 +1,203 @@ + + + + + + DestinyDestinationBubbleSettingDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyDestinationBubbleSettingDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Human readable data about the bubble. Combine with DestinyBubbleDefinition - see + DestinyDestinationDefinition.bubbleSettings for more information.

        +
        +

        DEPRECATED - Just use bubbles.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyDestinationBubbleSettingDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinydestinationdefinition.html b/docs/interfaces/destinydestinationdefinition.html new file mode 100644 index 0000000..4b88c49 --- /dev/null +++ b/docs/interfaces/destinydestinationdefinition.html @@ -0,0 +1,379 @@ + + + + + + DestinyDestinationDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyDestinationDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        On to one of the more confusing subjects of the API. What is a Destination, and + what is the relationship between it, Activities, Locations, and Places?

        +
        +

        A "Destination" is a specific region/city/area of a larger "Place". For instance, + a Place might be Earth where a Destination might be Bellevue, Washington. ( + Please, pick a more interesting destination if you come to visit Earth).

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyDestinationDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activityGraphEntries

        + + +
        +
        +

        If the Destination has default Activity Graphs (i.e. "Map") that should be shown + in the director, this is the list of those Graphs. At most, only one should be + active at any given time for a Destination: these would represent, for example, + different variants on a Map if the Destination is changing on a macro level + based on game state.

        +
        +
        +
        +
        + +

        bubbleSettings

        + + +
        +
        +

        A Destination may have many "Bubbles" zones with human readable properties.

        +
        +

        We don't get as much info as I'd like about them - I'd love to return info like + where on the map they are located - but at least this gives you the name of + those bubbles. bubbleSettings and bubbles both have the identical number of + entries, and you should match up their indexes to provide matching bubble and + bubbleSettings data.

        +

        DEPRECATED - Just use bubbles, it now has this data.

        +
        +
        +
        + +

        bubbles

        + + +
        +
        +

        This provides the unique identifiers for every bubble in the destination (only + guaranteed unique within the destination), and any intrinsic properties of the + bubble.

        +
        +

        bubbleSettings and bubbles both have the identical number of entries, and you + should match up their indexes to provide matching bubble and bubbleSettings data.

        +
        +
        +
        + +

        defaultFreeroamActivityHash

        +
        defaultFreeroamActivityHash: number
        + +
        +
        +

        If this Destination has a default Free-Roam activity, this is the hash for that + Activity. Use it to look up the DestinyActivityDefintion.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        displayProperties

        + + +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        placeHash

        +
        placeHash: number
        + +
        +
        +

        The place that "owns" this Destination. Use this hash to look up the + DestinyPlaceDefinition.

        +
        +

        Mapped to DestinyPlaceDefinition in the manifest.

        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinydisplaycategorydefinition.html b/docs/interfaces/destinydisplaycategorydefinition.html new file mode 100644 index 0000000..80c1763 --- /dev/null +++ b/docs/interfaces/destinydisplaycategorydefinition.html @@ -0,0 +1,342 @@ + + + + + + DestinyDisplayCategoryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyDisplayCategoryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Display Categories are different from "categories" in that these are + specifically for visual grouping and display of categories in Vendor UI. The " + categories" structure is for validation of the contained items, and can be + categorized entirely separately from "Display Categories", there need be and + often will be no meaningful relationship between the two.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyDisplayCategoryDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        displayCategoryHash

        +
        displayCategoryHash: number
        + +
        +
        + +

        displayInBanner

        +
        displayInBanner: boolean
        + +
        +
        +

        If true, this category should be displayed in the "Banner" section of the vendor' + s UI.

        +
        +
        +
        +
        + +

        displayProperties

        + + +
        +
        + +

        Optional displayStyleHash

        +
        displayStyleHash: number
        + +
        +
        +

        An indicator of how the category will be displayed in the UI. It's up to you to + do something cool or interesting in response to this, or just to treat it as a + normal category.

        +
        +
        +
        +
        + +

        displayStyleIdentifier

        +
        displayStyleIdentifier: string
        + +
        +
        +

        An indicator of how the category will be displayed in the UI. It's up to you to + do something cool or interesting in response to this, or just to treat it as a + normal category.

        +
        +
        +
        +
        + +

        identifier

        +
        identifier: string
        + +
        +
        +

        A string identifier for the display category.

        +
        +
        +
        +
        + +

        Optional progressionHash

        +
        progressionHash: number
        + +
        +
        +

        If it exists, this is the hash identifier of a DestinyProgressionDefinition that + represents the progression to show on this display category.

        +
        +

        Specific categories can now have thier own distinct progression, apparently. So + that's cool.

        +

        Mapped to DestinyProgressionDefinition in the manifest.

        +
        +
        +
        + +

        sortOrder

        + + +
        +
        +

        If this category sorts items in a nonstandard way, this will be the way we sort.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinydisplaypropertiesdefinition.html b/docs/interfaces/destinydisplaypropertiesdefinition.html new file mode 100644 index 0000000..bc29cee --- /dev/null +++ b/docs/interfaces/destinydisplaypropertiesdefinition.html @@ -0,0 +1,255 @@ + + + + + + DestinyDisplayPropertiesDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyDisplayPropertiesDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Many Destiny*Definition contracts - the "first order" entities of Destiny that + have their own tables in the Manifest Database - also have displayable + information. This is the base class for that display information.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyDisplayPropertiesDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        description

        +
        description: string
        + +
        +
        + +

        hasIcon

        +
        hasIcon: boolean
        + +
        +
        + +

        icon

        +
        icon: string
        + +
        +
        +

        Note that "icon" is sometimes misleading, and should be interpreted in the + context of the entity. For instance, in Destiny 1 the + DestinyRecordBookDefinition's icon was a big picture of a book.

        +
        +

        But usually, it will be a small square image that you can use as... well, an + icon.

        +

        They are currently represented as 96px x 96px images.

        +
        +
        +
        + +

        name

        +
        name: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyentitysearchresult.html b/docs/interfaces/destinyentitysearchresult.html new file mode 100644 index 0000000..6fb1c31 --- /dev/null +++ b/docs/interfaces/destinyentitysearchresult.html @@ -0,0 +1,229 @@ + + + + + + DestinyEntitySearchResult | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyEntitySearchResult

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The results of a search for Destiny content. This will be improved on over time, + I've been doing some experimenting to see what might be useful.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyEntitySearchResult +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        results

        + + +
        +
        +

        The items found that are matches/near matches for the searched-for term, sorted + by something vaguely resembling "relevance". Hopefully this will get better in + the future.

        +
        +
        +
        +
        + +

        suggestedWords

        +
        suggestedWords: string[]
        + +
        +
        +

        A list of suggested words that might make for better search results, based on + the text searched for.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyentitysearchresultitem.html b/docs/interfaces/destinyentitysearchresultitem.html new file mode 100644 index 0000000..806e613 --- /dev/null +++ b/docs/interfaces/destinyentitysearchresultitem.html @@ -0,0 +1,268 @@ + + + + + + DestinyEntitySearchResultItem | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyEntitySearchResultItem

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        An individual Destiny Entity returned from the entity search.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyEntitySearchResultItem +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        +

        Basic display properties on the entity, so you don't have to look up the + definition to show basic results for the item.

        +
        +
        +
        +
        + +

        entityType

        +
        entityType: string
        + +
        +
        +

        The type of entity, returned as a string matching the DestinyDefinition's + contract class name. You'll have to have your own mapping from class names to + actually looking up those definitions in the manifest databases.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The hash identifier of the entity. You will use this to look up the + DestinyDefinition relevant for the entity found.

        +
        +
        +
        +
        + +

        weight

        +
        weight: number
        + +
        +
        +

        The ranking value for sorting that we calculated using our relevance formula. + This will hopefully get better with time and iteration.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyenvironmentlocationmapping.html b/docs/interfaces/destinyenvironmentlocationmapping.html new file mode 100644 index 0000000..4e0445f --- /dev/null +++ b/docs/interfaces/destinyenvironmentlocationmapping.html @@ -0,0 +1,285 @@ + + + + + + DestinyEnvironmentLocationMapping | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyEnvironmentLocationMapping

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyEnvironmentLocationMapping +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activationSource

        +
        activationSource: string
        + +
        +
        +

        A hint that the UI uses to figure out how this location is activated by the + player.

        +
        +
        +
        +
        + +

        Optional activityHash

        +
        activityHash: number
        + +
        +
        +

        If this is populated, this is the activity you have to be playing in order to + see this location appear because of this mapping. (theoretically, a location can + have multiple mappings, and some might require you to be in a specific activity + when others don't)

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        Optional itemHash

        +
        itemHash: number
        + +
        +
        +

        If this is populated, it is the item that you must possess for this location to + be active because of this mapping. (theoretically, a location can have multiple + mappings, and some might require an item while others don't)

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        locationHash

        +
        locationHash: number
        + +
        +
        +

        The location that is revealed on the director by this mapping.

        +
        +

        Mapped to DestinyLocationDefinition in the manifest.

        +
        +
        +
        + +

        Optional objectiveHash

        +
        objectiveHash: number
        + +
        +
        +

        If this is populated, this is an objective related to the location.

        +
        +

        Mapped to DestinyObjectiveDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyequipitemresult.html b/docs/interfaces/destinyequipitemresult.html new file mode 100644 index 0000000..2536778 --- /dev/null +++ b/docs/interfaces/destinyequipitemresult.html @@ -0,0 +1,227 @@ + + + + + + DestinyEquipItemResult | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyEquipItemResult

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The results of an Equipping operation performed through the Destiny API.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyEquipItemResult +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        equipStatus

        +
        equipStatus: PlatformErrorCodes
        + +
        +
        +

        A PlatformErrorCodes enum indicating whether it succeeded, and if it failed why.

        +
        +
        +
        +
        + +

        itemInstanceId

        +
        itemInstanceId: string
        + +
        +
        +

        The instance ID of the item in question (all items that can be equipped must, + but definition, be Instanced and thus have an Instance ID that you can use to + refer to them)

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyequipitemresults.html b/docs/interfaces/destinyequipitemresults.html new file mode 100644 index 0000000..8c7f37f --- /dev/null +++ b/docs/interfaces/destinyequipitemresults.html @@ -0,0 +1,201 @@ + + + + + + DestinyEquipItemResults | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyEquipItemResults

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The results of a bulk Equipping operation performed through the Destiny API.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyEquipItemResults +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        equipResults

        +
        equipResults: DestinyEquipItemResult[]
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyequipmentslotdefinition.html b/docs/interfaces/destinyequipmentslotdefinition.html new file mode 100644 index 0000000..1d17ba7 --- /dev/null +++ b/docs/interfaces/destinyequipmentslotdefinition.html @@ -0,0 +1,354 @@ + + + + + + DestinyEquipmentSlotDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyEquipmentSlotDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Characters can not only have Inventory buckets (containers of items that are + generally matched by their type or functionality), they can also have Equipment + Slots.

        +
        +

        The Equipment Slot is an indicator that the related bucket can have instanced + items equipped on the character. For instance, the Primary Weapon bucket has an + Equipment Slot that determines whether you can equip primary weapons, and holds + the association between its slot and the inventory bucket from which it can have + items equipped.

        +

        An Equipment Slot must have a related Inventory Bucket, but not all inventory + buckets must have Equipment Slots.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyEquipmentSlotDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        applyCustomArtDyes

        +
        applyCustomArtDyes: boolean
        + +
        +
        +

        If True, equipped items should have their custom art dyes applied when rendering + the item. Otherwise, custom art dyes on an item should be ignored if the item is + equipped in this slot.

        +
        +
        +
        +
        + +

        artDyeChannels

        +
        artDyeChannels: DestinyArtDyeReference[]
        + +
        +
        +

        The Art Dye Channels that apply to this equipment slot.

        +
        +
        +
        +
        + +

        bucketTypeHash

        +
        bucketTypeHash: number
        + +
        +
        +

        The inventory bucket that owns this equipment slot.

        +
        +

        Mapped to DestinyInventoryBucketDefinition in the manifest.

        +
        +
        +
        + +

        displayProperties

        + + +
        +
        + +

        equipmentCategoryHash

        +
        equipmentCategoryHash: number
        + +
        +
        +

        These technically point to "Equipment Category Definitions". But don't get + excited. There's nothing of significant value in those definitions, so I didn't + bother to expose them. You can use the hash here to group equipment slots by + common functionality, which serves the same purpose as if we had the Equipment + Category definitions exposed.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyequippingblockdefinition.html b/docs/interfaces/destinyequippingblockdefinition.html new file mode 100644 index 0000000..9f6c032 --- /dev/null +++ b/docs/interfaces/destinyequippingblockdefinition.html @@ -0,0 +1,337 @@ + + + + + + DestinyEquippingBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyEquippingBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Items that can be equipped define this block. It contains information we need to + understand how and when the item can be equipped.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyEquippingBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        ammoType

        + + +
        +
        +

        Ammo type used by a weapon is no longer determined by the bucket in which it is + contained. If the item has an ammo type - i.e. if it is a weapon - this will be + the type of ammunition expected.

        +
        +
        +
        +
        + +

        attributes

        + + +
        +
        +

        These are custom attributes on the equippability of the item.

        +
        +

        For now, this can only be "equip on acquire", which would mean that the item + will be automatically equipped as soon as you pick it up.

        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        + +

        displayStrings

        +
        displayStrings: string[]
        + +
        +
        +

        These are strings that represent the possible Game/Account/Character state + failure conditions that can occur when trying to equip the item. They match up + one-to-one with requiredUnlockExpressions.

        +
        +
        +
        +
        + +

        equipmentSlotTypeHash

        +
        equipmentSlotTypeHash: number
        + +
        +
        +

        An equipped item must be equipped in an Equipment Slot. This is the hash + identifier of the DestinyEquipmentSlotDefinition into which it must be equipped.

        +
        +

        Mapped to DestinyEquipmentSlotDefinition in the manifest.

        +
        +
        +
        + +

        Optional gearsetItemHash

        +
        gearsetItemHash: number
        + +
        +
        +

        If the item is part of a gearset, this is a reference to that gearset item.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        uniqueLabel

        +
        uniqueLabel: string
        + +
        +
        +

        If defined, this is the label used to check if the item has other items of + matching types already equipped.

        +
        +

        For instance, when you aren't allowed to equip more than one Exotic Weapon, that' + s because all exotic weapons have identical uniqueLabels and the game checks the + to-be-equipped item's uniqueLabel vs. all other already equipped items (other + than the item in the slot that's about to be occupied).

        +
        +
        +
        + +

        uniqueLabelHash

        +
        uniqueLabelHash: number
        + +
        +
        +

        The hash of that unique label. Does not point to a specific definition.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyerrorprofile.html b/docs/interfaces/destinyerrorprofile.html new file mode 100644 index 0000000..d59ee25 --- /dev/null +++ b/docs/interfaces/destinyerrorprofile.html @@ -0,0 +1,231 @@ + + + + + + DestinyErrorProfile | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyErrorProfile

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If a Destiny Profile can't be returned, but we're pretty certain it's a valid + Destiny account, this will contain as much info as we can get about the profile + for your use.

        +
        +

        Assume that the most you'll get is the Error Code, the Membership Type and the + Membership ID.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyErrorProfile +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        errorCode

        + + +
        +
        +

        The error that we encountered. You should be able to look up localized text to + show to the user for these failures.

        +
        +
        +
        +
        + +

        infoCard

        +
        infoCard: UserInfoCard
        + +
        +
        +

        Basic info about the account that failed. Don't expect anything other than + membership ID, Membership Type, and displayName to be populated.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyfactiondefinition.html b/docs/interfaces/destinyfactiondefinition.html new file mode 100644 index 0000000..d5dc3df --- /dev/null +++ b/docs/interfaces/destinyfactiondefinition.html @@ -0,0 +1,377 @@ + + + + + + DestinyFactionDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyFactionDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        These definitions represent Factions in the game. Factions have ended up + unilaterally being related to Vendors that represent them, but that need not + necessarily be the case.

        +
        +

        A Faction is really just an entity that has a related progression for which a + character can gain experience. In Destiny 1, Dead Orbit was an example of a + Faction: there happens to be a Vendor that represents Dead Orbit (and indeed, + DestinyVendorDefinition.factionHash defines to this relationship), but Dead + Orbit could theoretically exist without the Vendor that provides rewards.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyFactionDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        progressionHash

        +
        progressionHash: number
        + +
        +
        +

        The hash identifier for the DestinyProgressionDefinition that indicates the + character's relationship with this faction in terms of experience and levels.

        +
        +

        Mapped to DestinyProgressionDefinition in the manifest.

        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        rewardItemHash

        +
        rewardItemHash: number
        + +
        +
        +

        The faction reward item hash, usually an engram.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        rewardVendorHash

        +
        rewardVendorHash: number
        + +
        +
        +

        The faction reward vendor hash, used for faction engram previews.

        +
        +

        Mapped to DestinyVendorDefinition in the manifest.

        +
        +
        +
        + +

        tokenValues

        +
        tokenValues: object
        + +
        +
        +

        The faction token item hashes, and their respective progression values.

        +
        +
        +
        +

        Type declaration

        +
          +
        • +
          [key: number]: number
          +
        • +
        +
        +
        +
        + +

        vendors

        + + +
        +
        +

        List of vendors that are associated with this faction. The last vendor that + passes the unlock flag checks is the one that should be shown.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyfactionprogression.html b/docs/interfaces/destinyfactionprogression.html new file mode 100644 index 0000000..b70a9d5 --- /dev/null +++ b/docs/interfaces/destinyfactionprogression.html @@ -0,0 +1,450 @@ + + + + + + DestinyFactionProgression | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyFactionProgression

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Mostly for historical purposes, we segregate Faction progressions from other + progressions. This is just a DestinyProgression with a shortcut for finding the + DestinyFactionDefinition of the faction related to the progression.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyFactionProgression +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        currentProgress

        +
        currentProgress: number
        + +
        +
        +

        This is the total amount of progress obtained overall for this progression (for + instance, the total amount of Character Level experience earned)

        +
        +
        +
        +
        + +

        dailyLimit

        +
        dailyLimit: number
        + +
        +
        +

        If this progression has a daily limit, this is that limit.

        +
        +
        +
        +
        + +

        dailyProgress

        +
        dailyProgress: number
        + +
        +
        +

        The amount of progress earned today for this progression.

        +
        +
        +
        +
        + +

        factionHash

        +
        factionHash: number
        + +
        +
        +

        The hash identifier of the Faction related to this progression. Use it to look + up the DestinyFactionDefinition for more rendering info.

        +
        +

        Mapped to DestinyFactionDefinition in the manifest.

        +
        +
        +
        + +

        factionVendorIndex

        +
        factionVendorIndex: number
        + +
        +
        +

        The index of the Faction vendor that is currently available. Will be set to -1 + if no vendors are available.

        +
        +
        +
        +
        + +

        level

        +
        level: number
        + +
        +
        +

        This is the level of the progression (for instance, the Character Level).

        +
        +
        +
        +
        + +

        levelCap

        +
        levelCap: number
        + +
        +
        +

        This is the maximum possible level you can achieve for this progression (for + example, the maximum character level obtainable)

        +
        +
        +
        +
        + +

        nextLevelAt

        +
        nextLevelAt: number
        + +
        +
        +

        The total amount of progression (i.e. "Experience") needed in order to reach the + next level.

        +
        +
        +
        +
        + +

        progressToNextLevel

        +
        progressToNextLevel: number
        + +
        +
        +

        The amount of progression (i.e. "Experience") needed to reach the next level of + this Progression. Jeez, progression is such an overloaded word.

        +
        +
        +
        +
        + +

        progressionHash

        +
        progressionHash: number
        + +
        +
        +

        The hash identifier of the Progression in question. Use it to look up the + DestinyProgressionDefinition in static data.

        +
        +

        Mapped to DestinyProgressionDefinition in the manifest.

        +
        +
        +
        + +

        stepIndex

        +
        stepIndex: number
        + +
        +
        +

        Progressions define their levels in "steps". Since the last step may be + repeatable, the user may be at a higher level than the actual Step achieved in + the progression. Not necessarily useful, but potentially interesting for those + cruising the API. Relate this to the "steps" property of the DestinyProgression + to see which step the user is on, if you care about that. (Note that this is + Content Version dependent since it refers to indexes.)

        +
        +
        +
        +
        + +

        weeklyLimit

        +
        weeklyLimit: number
        + +
        +
        +

        If this progression has a weekly limit, this is that limit.

        +
        +
        +
        +
        + +

        weeklyProgress

        +
        weeklyProgress: number
        + +
        +
        +

        The amount of progress earned toward this progression in the current week.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyfactionvendordefinition.html b/docs/interfaces/destinyfactionvendordefinition.html new file mode 100644 index 0000000..e9659c4 --- /dev/null +++ b/docs/interfaces/destinyfactionvendordefinition.html @@ -0,0 +1,250 @@ + + + + + + DestinyFactionVendorDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyFactionVendorDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        These definitions represent faction vendors at different points in the game.

        +
        +

        A single faction may contain multiple vendors, or the same vendor available at + two different locations.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyFactionVendorDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        backgroundImagePath

        +
        backgroundImagePath: string
        + +
        +
        +

        The relative path to the background image representing this Vendor at this + location, for use in a banner.

        +
        +
        +
        +
        + +

        destinationHash

        +
        destinationHash: number
        + +
        +
        +

        The hash identifier for a Destination at which this vendor may be located. Each + destination where a Vendor may exist will only ever have a single entry.

        +
        +

        Mapped to DestinyDestinationDefinition in the manifest.

        +
        +
        +
        + +

        vendorHash

        +
        vendorHash: number
        + +
        +
        +

        The faction vendor hash.

        +
        +

        Mapped to DestinyVendorDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinygearartarrangementreference.html b/docs/interfaces/destinygearartarrangementreference.html new file mode 100644 index 0000000..7af1ba3 --- /dev/null +++ b/docs/interfaces/destinygearartarrangementreference.html @@ -0,0 +1,208 @@ + + + + + + DestinyGearArtArrangementReference | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyGearArtArrangementReference

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyGearArtArrangementReference +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        artArrangementHash

        +
        artArrangementHash: number
        + +
        +
        + +

        classHash

        +
        classHash: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinygenderdefinition.html b/docs/interfaces/destinygenderdefinition.html new file mode 100644 index 0000000..c4b1f17 --- /dev/null +++ b/docs/interfaces/destinygenderdefinition.html @@ -0,0 +1,284 @@ + + + + + + DestinyGenderDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyGenderDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Gender is a social construct, and as such we have definitions for Genders. Right + now there happens to only be two, but we'll see what the future holds.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyGenderDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        + +

        genderType

        +
        genderType: DestinyGender
        + +
        +
        +

        This is a quick reference enumeration for all of the currently defined Genders. + We use the enumeration for quicker lookups in related data, like + DestinyClassDefinition.genderedClassNames.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyhistoricalstatsaccountresult.html b/docs/interfaces/destinyhistoricalstatsaccountresult.html new file mode 100644 index 0000000..424188d --- /dev/null +++ b/docs/interfaces/destinyhistoricalstatsaccountresult.html @@ -0,0 +1,222 @@ + + + + + + DestinyHistoricalStatsAccountResult | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyHistoricalStatsAccountResult

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyHistoricalStatsAccountResult +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        characters

        + + +
        +
        + +

        mergedAllCharacters

        + + +
        +
        + +

        mergedDeletedCharacters

        +
        mergedDeletedCharacters: DestinyHistoricalStatsWithMerged
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyhistoricalstatsactivity.html b/docs/interfaces/destinyhistoricalstatsactivity.html new file mode 100644 index 0000000..11e4519 --- /dev/null +++ b/docs/interfaces/destinyhistoricalstatsactivity.html @@ -0,0 +1,309 @@ + + + + + + DestinyHistoricalStatsActivity | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyHistoricalStatsActivity

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Summary information about the activity that was played.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyHistoricalStatsActivity +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        directorActivityHash

        +
        directorActivityHash: number
        + +
        +
        +

        The unique hash identifier of the DestinyActivityDefinition that was played.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        instanceId

        +
        instanceId: string
        + +
        +
        +

        The unique identifier for this specific match that was played.

        +
        +

        This value can be used to get additional data about this activity such as who + else was playing via the GetPostGameCarnageReport endpoint.

        +
        +
        +
        + +

        isPrivate

        +
        isPrivate: boolean
        + +
        +
        +

        Whether or not the match was a private match. There's no private matches in + Destiny 2... yet... DUN DUN DUNNNN

        +
        +
        +
        +
        + +

        mode

        + + +
        +
        +

        Indicates the most specific game mode of the activity that we could find.

        +
        +
        +
        +
        + +

        modes

        + + +
        +
        +

        The list of all Activity Modes to which this activity applies, including + aggregates. This will let you see, for example, whether the activity was both + Clash and part of the Trials of the Nine event.

        +
        +
        +
        +
        + +

        referenceId

        +
        referenceId: number
        + +
        +
        +

        The unique hash identifier of the DestinyActivityDefinition that was played. If + I had this to do over, it'd be named activityHash. Too late now.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyhistoricalstatsbyperiod.html b/docs/interfaces/destinyhistoricalstatsbyperiod.html new file mode 100644 index 0000000..d044d07 --- /dev/null +++ b/docs/interfaces/destinyhistoricalstatsbyperiod.html @@ -0,0 +1,296 @@ + + + + + + DestinyHistoricalStatsByPeriod | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyHistoricalStatsByPeriod

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyHistoricalStatsByPeriod +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        allTime

        +
        allTime: object
        + +
        +

        Type declaration

        + +
        +
        +
        + +

        allTimeTier1

        +
        allTimeTier1: object
        + +
        +

        Type declaration

        + +
        +
        +
        + +

        allTimeTier2

        +
        allTimeTier2: object
        + +
        +

        Type declaration

        + +
        +
        +
        + +

        allTimeTier3

        +
        allTimeTier3: object
        + +
        +

        Type declaration

        + +
        +
        +
        + +

        daily

        + + +
        +
        + +

        monthly

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyhistoricalstatsdefinition.html b/docs/interfaces/destinyhistoricalstatsdefinition.html new file mode 100644 index 0000000..8d796f8 --- /dev/null +++ b/docs/interfaces/destinyhistoricalstatsdefinition.html @@ -0,0 +1,446 @@ + + + + + + DestinyHistoricalStatsDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyHistoricalStatsDefinition

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyHistoricalStatsDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        category

        + + +
        +
        +

        Category for the stat.

        +
        +
        +
        +
        + +

        group

        + + +
        +
        +

        Statistic group

        +
        +
        +
        +
        + +

        iconImage

        +
        iconImage: string
        + +
        +
        +

        Optional URI to an icon for the statistic

        +
        +
        +
        +
        + +

        Optional medalTierHash

        +
        medalTierHash: number
        + +
        +
        +

        The tier associated with this medal - be it implicitly or explicitly.

        +
        +
        +
        +
        + +

        Optional mergeMethod

        +
        mergeMethod: number
        + +
        +
        +

        Optional icon for the statistic

        +
        +
        +
        +
        + +

        modes

        + + +
        +
        +

        Game modes where this statistic can be reported.

        +
        +
        +
        +
        + +

        periodTypes

        +
        periodTypes: PeriodType[]
        + +
        +
        +

        Time periods the statistic covers

        +
        +
        +
        +
        + +

        statDescription

        +
        statDescription: string
        + +
        +
        +

        Description of a stat if applicable.

        +
        +
        +
        +
        + +

        statId

        +
        statId: string
        + +
        +
        +

        Unique programmer friendly ID for this stat

        +
        +
        +
        +
        + +

        statName

        +
        statName: string
        + +
        +
        +

        Display name

        +
        +
        +
        +
        + +

        statNameAbbr

        +
        statNameAbbr: string
        + +
        +
        +

        Display name abbreviated

        +
        +
        +
        +
        + +

        unitLabel

        +
        unitLabel: string
        + +
        +
        +

        Localized Unit Name for the stat.

        +
        +
        +
        +
        + +

        unitType

        +
        unitType: UnitType
        + +
        +
        +

        Unit, if any, for the statistic

        +
        +
        +
        +
        + +

        weight

        +
        weight: number
        + +
        +
        +

        Weight assigned to this stat indicating its relative impressiveness.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyhistoricalstatspercharacter.html b/docs/interfaces/destinyhistoricalstatspercharacter.html new file mode 100644 index 0000000..5e4a858 --- /dev/null +++ b/docs/interfaces/destinyhistoricalstatspercharacter.html @@ -0,0 +1,244 @@ + + + + + + DestinyHistoricalStatsPerCharacter | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyHistoricalStatsPerCharacter

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyHistoricalStatsPerCharacter +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        characterId

        +
        characterId: string
        + +
        +
        + +

        deleted

        +
        deleted: boolean
        + +
        +
        + +

        merged

        + + +
        +
        + +

        results

        +
        results: object
        + +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyhistoricalstatsperiodgroup.html b/docs/interfaces/destinyhistoricalstatsperiodgroup.html new file mode 100644 index 0000000..89a8b65 --- /dev/null +++ b/docs/interfaces/destinyhistoricalstatsperiodgroup.html @@ -0,0 +1,247 @@ + + + + + + DestinyHistoricalStatsPeriodGroup | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyHistoricalStatsPeriodGroup

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyHistoricalStatsPeriodGroup +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activityDetails

        + + +
        +
        +

        If the period group is for a specific activity, this property will be set.

        +
        +
        +
        +
        + +

        period

        +
        period: string
        + +
        +
        +

        Period for the group. If the stat periodType is day, then this will have a + specific day. If the type is monthly, then this value will be the first day of + the applicable month. This value is not set when the periodType is 'all time'.

        +
        +
        +
        +
        + +

        values

        +
        values: object
        + +
        +
        +

        Collection of stats for the period.

        +
        +
        +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyhistoricalstatsvalue.html b/docs/interfaces/destinyhistoricalstatsvalue.html new file mode 100644 index 0000000..c93a841 --- /dev/null +++ b/docs/interfaces/destinyhistoricalstatsvalue.html @@ -0,0 +1,277 @@ + + + + + + DestinyHistoricalStatsValue | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyHistoricalStatsValue

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyHistoricalStatsValue +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        Optional activityId

        +
        activityId: string
        + +
        +
        +

        When a stat represents the best, most, longest, fastest or some other personal + best, the actual activity ID where that personal best was established is + available on this property.

        +
        +
        +
        +
        + +

        basic

        + + +
        +
        +

        Basic stat value.

        +
        +
        +
        +
        + +

        pga

        + + +
        +
        +

        Per game average for the statistic, if applicable

        +
        +
        +
        +
        + +

        statId

        +
        statId: string
        + +
        +
        +

        Unique ID for this stat

        +
        +
        +
        +
        + +

        weighted

        + + +
        +
        +

        Weighted value of the stat if a weight greater than 1 has been assigned.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyhistoricalstatsvaluepair.html b/docs/interfaces/destinyhistoricalstatsvaluepair.html new file mode 100644 index 0000000..a8b506a --- /dev/null +++ b/docs/interfaces/destinyhistoricalstatsvaluepair.html @@ -0,0 +1,218 @@ + + + + + + DestinyHistoricalStatsValuePair | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyHistoricalStatsValuePair

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyHistoricalStatsValuePair +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayValue

        +
        displayValue: string
        + +
        +
        +

        Localized formated version of the value.

        +
        +
        +
        +
        + +

        value

        +
        value: number
        + +
        +
        +

        Raw value of the statistic

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyhistoricalstatswithmerged.html b/docs/interfaces/destinyhistoricalstatswithmerged.html new file mode 100644 index 0000000..2d96565 --- /dev/null +++ b/docs/interfaces/destinyhistoricalstatswithmerged.html @@ -0,0 +1,216 @@ + + + + + + DestinyHistoricalStatsWithMerged | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyHistoricalStatsWithMerged

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyHistoricalStatsWithMerged +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        merged

        + + +
        +
        + +

        results

        +
        results: object
        + +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyhistoricalweaponstats.html b/docs/interfaces/destinyhistoricalweaponstats.html new file mode 100644 index 0000000..a173d8a --- /dev/null +++ b/docs/interfaces/destinyhistoricalweaponstats.html @@ -0,0 +1,227 @@ + + + + + + DestinyHistoricalWeaponStats | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyHistoricalWeaponStats

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyHistoricalWeaponStats +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        referenceId

        +
        referenceId: number
        + +
        +
        +

        The hash ID of the item definition that describes the weapon.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        values

        +
        values: object
        + +
        +
        +

        Collection of stats for the period.

        +
        +
        +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyhistoricalweaponstatsdata.html b/docs/interfaces/destinyhistoricalweaponstatsdata.html new file mode 100644 index 0000000..27a9c7e --- /dev/null +++ b/docs/interfaces/destinyhistoricalweaponstatsdata.html @@ -0,0 +1,199 @@ + + + + + + DestinyHistoricalWeaponStatsData | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyHistoricalWeaponStatsData

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyHistoricalWeaponStatsData +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        weapons

        + + +
        +
        +

        List of weapons and their perspective values.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyinsertplugactiondefinition.html b/docs/interfaces/destinyinsertplugactiondefinition.html new file mode 100644 index 0000000..0c911f7 --- /dev/null +++ b/docs/interfaces/destinyinsertplugactiondefinition.html @@ -0,0 +1,230 @@ + + + + + + DestinyInsertPlugActionDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyInsertPlugActionDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Data related to what happens while a plug is being inserted, mostly for UI + purposes.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyInsertPlugActionDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        actionExecuteSeconds

        +
        actionExecuteSeconds: number
        + +
        +
        +

        How long it takes for the Plugging of the item to be completed once it is + initiated, if you care.

        +
        +
        +
        +
        + +

        actionType

        + + +
        +
        +

        The type of action being performed when you act on this Socket Type. The most + common value is "insert plug", but there are others as well (for instance, a " + Masterwork" socket may allow for Re-initialization, and an Infusion socket + allows for items to be consumed to upgrade the item)

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyinsertplugsactionrequest.html b/docs/interfaces/destinyinsertplugsactionrequest.html new file mode 100644 index 0000000..8b20854 --- /dev/null +++ b/docs/interfaces/destinyinsertplugsactionrequest.html @@ -0,0 +1,266 @@ + + + + + + DestinyInsertPlugsActionRequest | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyInsertPlugsActionRequest

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyInsertPlugsActionRequest +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        actionToken

        +
        actionToken: string
        + +
        +
        +

        Action token provided by the AwaGetActionToken API call.

        +
        +
        +
        +
        + +

        characterId

        +
        characterId: string
        + +
        +
        + +

        itemInstanceId

        +
        itemInstanceId: string
        + +
        +
        +

        The instance ID of the item having a plug inserted. Only instanced items can + have sockets.

        +
        +
        +
        +
        + +

        membershipType

        +
        membershipType: BungieMembershipType
        + +
        +
        + +

        plug

        + + +
        +
        +

        The plugs being inserted.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyinsertplugsrequestentry.html b/docs/interfaces/destinyinsertplugsrequestentry.html new file mode 100644 index 0000000..d7513bf --- /dev/null +++ b/docs/interfaces/destinyinsertplugsrequestentry.html @@ -0,0 +1,255 @@ + + + + + + DestinyInsertPlugsRequestEntry | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyInsertPlugsRequestEntry

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents all of the data related to a single plug to be inserted.

        +
        +

        Note that, while you can point to a socket that represents infusion, you will + receive an error if you attempt to do so. Come on guys, let's play nice.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyInsertPlugsRequestEntry +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        plugItemHash

        +
        plugItemHash: number
        + +
        +
        +

        Plugs are never instanced (except in infusion). So with the hash alone, we + should be able to: 1) Infer whether the player actually needs to have the item, + or if it's a reusable plug 2) Perform any operation needed to use the Plug, + including removing the plug item and running reward sheets.

        +
        +
        +
        +
        + +

        socketArrayType

        +
        socketArrayType: DestinySocketArrayType
        + +
        +
        +

        This property, combined with the socketIndex, tells us which socket we are + referring to (since operations can be performed on both Intrinsic and "default" + sockets, and they occupy different arrays in the Inventory Item Definition). I + know, I know. Don't give me that look.

        +
        +
        +
        +
        + +

        socketIndex

        +
        socketIndex: number
        + +
        +
        +

        The index into the socket array, which identifies the specific socket being + operated on. We also need to know the socketArrayType in order to uniquely + identify the socket.

        +
        +

        Don't point to or try to insert a plug into an infusion socket. It won't work.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyinventorybucketdefinition.html b/docs/interfaces/destinyinventorybucketdefinition.html new file mode 100644 index 0000000..bff4557 --- /dev/null +++ b/docs/interfaces/destinyinventorybucketdefinition.html @@ -0,0 +1,449 @@ + + + + + + DestinyInventoryBucketDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyInventoryBucketDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        An Inventory (be it Character or Profile level) is comprised of many Buckets. An + example of a bucket is "Primary Weapons", where all of the primary weapons on a + character are gathered together into a single visual element in the UI: a subset + of the inventory that has a limited number of slots, and in this case also has + an associated Equipment Slot for equipping an item in the bucket.

        +
        +

        Item definitions declare what their "default" bucket is ( + DestinyInventoryItemDefinition.inventory.bucketTypeHash), and Item instances + will tell you which bucket they are currently residing in (DestinyItemComponent. + bucketHash). You can use this information along with the + DestinyInventoryBucketDefinition to show these items grouped by bucket.

        +

        You cannot transfer an item to a bucket that is not its Default without going + through a Vendor's "accepted items" (DestinyVendorDefinition.acceptedItems). + This is how transfer functionality like the Vault is implemented, as a feature + of a Vendor. See the vendor's acceptedItems property for more details.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyInventoryBucketDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        bucketOrder

        +
        bucketOrder: number
        + +
        +
        +

        Use this property to provide a quick-and-dirty recommended ordering for buckets + in the UI. Most UIs will likely want to forsake this for something more custom + and manual.

        +
        +
        +
        +
        + +

        category

        +
        category: BucketCategory
        + +
        +
        +

        An enum value for what items can be found in the bucket. See the BucketCategory + enum for more details.

        +
        +
        +
        +
        + +

        displayProperties

        + + +
        +
        + +

        enabled

        +
        enabled: boolean
        + +
        +
        +

        If True, this bucket is enabled. Disabled buckets may include buckets that were + included for test purposes, or that were going to be used but then were + abandoned but never removed from content cough.

        +
        +
        +
        +
        + +

        fifo

        +
        fifo: boolean
        + +
        +
        +

        if a FIFO bucket fills up, it will delete the oldest item from said bucket when + a new item tries to be added to it. If this is FALSE, the bucket will not allow + new items to be placed in it until room is made by the user manually deleting + items from it. You can see an example of this with the Postmaster's bucket.

        +
        +
        +
        +
        + +

        hasTransferDestination

        +
        hasTransferDestination: boolean
        + +
        +
        +

        If TRUE, there is at least one Vendor that can transfer items to/from this + bucket. See the DestinyVendorDefinition's acceptedItems property for more + information on how transferring works.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        itemCount

        +
        itemCount: number
        + +
        +
        +

        The maximum # of item "slots" in a bucket. A slot is a given combination of item

        +
          +
        • quantity.
        • +
        +
        +

        For instance, a Weapon will always take up a single slot, and always have a + quantity of 1. But a material could take up only a single slot with hundreds of + quantity.

        +
        +
        +
        + +

        location

        +
        location: ItemLocation
        + +
        +
        +

        Sometimes, inventory buckets represent conceptual "locations" in the game that + might not be expected. This value indicates the conceptual location of the + bucket, regardless of where it is actually contained on the character/account.

        +
        +

        See ItemLocation for details.

        +

        Note that location includes the Vault and the Postmaster (both of whom being + just inventory buckets with additional actions that can be performed on them + through a Vendor)

        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        scope

        + + +
        +
        +

        Where the bucket is found. 0 = Character, 1 = Account

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyinventorycomponent.html b/docs/interfaces/destinyinventorycomponent.html new file mode 100644 index 0000000..51142bc --- /dev/null +++ b/docs/interfaces/destinyinventorycomponent.html @@ -0,0 +1,214 @@ + + + + + + DestinyInventoryComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyInventoryComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A list of minimal information for items in an inventory: be it a character's + inventory, or a Profile's inventory. (Note that the Vault is a collection of + inventory buckets in the Profile's inventory)

        +
        +

        Inventory Items returned here are in a flat list, but importantly they have a + bucketHash property that indicates the specific inventory bucket that is holding + them. These buckets constitute things like the separate sections of the Vault, + the user's inventory slots, etc. See DestinyInventoryBucketDefinition for more + info.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyInventoryComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        items

        + + +
        +
        +

        The items in this inventory. If you care to bucket them, use the item's + bucketHash property to group them.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyinventoryitemdefinition.html b/docs/interfaces/destinyinventoryitemdefinition.html new file mode 100644 index 0000000..87f6dc2 --- /dev/null +++ b/docs/interfaces/destinyinventoryitemdefinition.html @@ -0,0 +1,1325 @@ + + + + + + DestinyInventoryItemDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyInventoryItemDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        So much of what you see in Destiny is actually an Item used in a new and + creative way. This is the definition for Items in Destiny, which started off as + just entities that could exist in your Inventory but ended up being the backing + data for so much more: quests, reward previews, slots, and subclasses.

        +
        +

        In practice, you will want to associate this data with "live" item data from a + Bungie.Net Platform call: these definitions describe the item in generic, non- + instanced terms: but an actual instance of an item can vary widely from these + generic definitions.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyInventoryItemDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        action

        + + +
        +
        +

        If the item can be "used", this block will be non-null, and will have data + related to the action performed when using the item. (Guess what? 99% of the + time, this action is "dismantle". Shocker)

        +
        +
        +
        +
        + +

        allowActions

        +
        allowActions: boolean
        + +
        +
        +

        BNet may forbid the execution of actions on this item via the API. If that is + occurring, allowActions will be set to false.

        +
        +
        +
        +
        + +

        animations

        + + +
        +
        +

        If any animations were extracted from game content for this item, these will be + the definitions of those animations.

        +
        +
        +
        +
        + +

        backgroundColor

        +
        backgroundColor: DestinyColor
        + +
        +
        +

        Sometimes, an item will have a background color. Most notably this occurs with + Emblems, who use the Background Color for small character nameplates such as the + "friends" view you see in-game. There are almost certainly other items that have + background color as well, though I have not bothered to investigate what items + have it nor what purposes they serve: use it as you will.

        +
        +
        +
        +
        + +

        classType

        +
        classType: DestinyClass
        + +
        +
        +

        We run a similarly weak-sauce algorithm to try and determine whether an item is + restricted to a specific class. If we find it to be restricted in such a way, we + set this classType property to match the class' enumeration value so that users + can easily identify class restricted items.

        +
        +

        If you see a mis-classed item, please inform the developers in the Bungie API + forum.

        +
        +
        +
        + +

        Optional collectibleHash

        +
        collectibleHash: number
        + +
        +
        +

        If this item has a collectible related to it, this is the hash identifier of + that collectible entry.

        +
        +

        Mapped to DestinyCollectibleDefinition in the manifest.

        +
        +
        +
        + +

        damageTypeHashes

        +
        damageTypeHashes: number[]
        + +
        +
        +

        Theoretically, an item can have many possible damage types. In practice, this + is not true, but just in case weapons start being made that have multiple (for + instance, an item where a socket has reusable plugs for every possible damage + type that you can choose from freely), this field will return all of the + possible damage types that are available to the weapon by default.

        +
        +

        Mapped to DestinyDamageTypeDefinition in the manifest.

        +
        +
        +
        + +

        damageTypes

        +
        damageTypes: DamageType[]
        + +
        +
        +

        This is the list of all damage types that we know ahead of time the item can + take on. Unfortunately, this does not preclude the possibility of something + funky happening to give the item a damage type that cannot be predicted + beforehand: for example, if some designer decides to create arbitrary non- + reusable plugs that cause damage type to change.

        +
        +

        This damage type prediction will only use the following to determine potential + damage types:

        +
          +
        • Intrinsic perks

          +
        • +
        • Talent Node perks

          +
        • +
        • Known, reusable plugs for sockets

          +
        • +
        +
        +
        +
        + +

        defaultDamageType

        +
        defaultDamageType: DamageType
        + +
        +
        +

        If the item has a damage type that could be considered to be default, it will be + populated here.

        +
        +

        For various upsetting reasons, it's surprisingly cumbersome to figure this out. + I hope you're happy.

        +
        +
        +
        + +

        Optional defaultDamageTypeHash

        +
        defaultDamageTypeHash: number
        + +
        +
        +

        Similar to defaultDamageType, but represented as the hash identifier for a + DestinyDamageTypeDefinition.

        +
        +

        I will likely regret leaving in the enumeration versions of these properties, + but for now they're very convenient.

        +

        Mapped to DestinyDamageTypeDefinition in the manifest.

        +
        +
        +
        + +

        displayProperties

        + + +
        +
        + +

        displaySource

        +
        displaySource: string
        + +
        +
        +

        In theory, it is a localized string telling you about how you can find the item. + I really wish this was more consistent. Many times, it has nothing. Sometimes, + it's instead a more narrative-forward description of the item. Which is cool, + and I wish all properties had that data, but it should really be its own + property.

        +
        +
        +
        +
        + +

        doesPostmasterPullHaveSideEffects

        +
        doesPostmasterPullHaveSideEffects: boolean
        + +
        +
        +

        The boolean will indicate to us (and you!) whether something could happen when + you transfer this item from the Postmaster that might be considered a " + destructive" action.

        +
        +

        It is not feasible currently to tell you (or ourelves!) in a consistent way + whether this will actually cause a destructive action, so we are playing it + safe: if it has the potential to do so, we will not allow it to be transferred + from the Postmaster by default. You will need to check for this flag before + transferring an item from the Postmaster, or else you'll end up receiving an + error.

        +
        +
        +
        + +

        Optional emblemObjectiveHash

        +
        emblemObjectiveHash: number
        + +
        +
        +

        If the item is an emblem that has a special Objective attached to it - for + instance, if the emblem tracks PVP Kills, or what-have-you. This is a bit + different from, for example, the Vanguard Kill Tracker mod, which pipes data + into the "art channel". When I get some time, I would like to standardize these + so you can get at the values they expose without having to care about what they' + re being used for and how they are wired up, but for now here's the raw data.

        +
        +
        +
        +
        + +

        equippable

        +
        equippable: boolean
        + +
        +
        +

        If true, then you will be allowed to equip the item if you pass its other + requirements.

        +
        +

        This being false means that you cannot equip the item under any circumstances.

        +
        +
        +
        + +

        equippingBlock

        + + +
        +
        +

        If this item can be equipped, this block will be non-null and will be populated + with the conditions under which it can be equipped.

        +
        +
        +
        +
        + +

        gearset

        + + +
        +
        +

        If this item has related items in a "Gear Set", this will be non-null and the + relationships defined herein.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        inventory

        + + +
        +
        +

        If this item can exist in an inventory, this block will be non-null. In practice, + every item that currently exists has one of these blocks. But note that it is + not necessarily guaranteed.

        +
        +
        +
        +
        + +

        investmentStats

        + + +
        +
        +

        If the item has stats, this block will be defined. It has the "raw" investment + stats for the item. These investment stats don't take into account the ways that + the items can spawn, nor do they take into account any Stat Group + transformations. I have retained them for debugging purposes, but I do not know + how useful people will find them.

        +
        +
        +
        +
        + +

        itemCategoryHashes

        +
        itemCategoryHashes: number[]
        + +
        +
        +

        BNet attempts to make a more formal definition of item "Categories", as defined + by DestinyItemCategoryDefinition. This is a list of all Categories that we were + able to algorithmically determine that this item is a member of. (for instance, + that it's a "Weapon", that it's an "Auto Rifle", etc...)

        +
        +

        The algorithm for these is, unfortunately, volatile. If you believe you see a + miscategorized item, please let us know on the Bungie API forums.

        +

        Mapped to DestinyItemCategoryDefinition in the manifest.

        +
        +
        +
        + +

        itemSubType

        +
        itemSubType: DestinyItemSubType
        + +
        +
        +

        A value indicating the "sub-type" of the item. For instance, where an item might + have an itemType value "Weapon", this will be something more specific like "Auto + Rifle".

        +
        +

        itemCategoryHashes are the preferred way of identifying types, we have retained + this enum for its convenience.

        +
        +
        +
        + +

        itemType

        +
        itemType: DestinyItemType
        + +
        +
        +

        A value indicating the "base" the of the item. This enum is a useful but + dramatic oversimplification of what it means for an item to have a "Type". Still, + it's handy in many situations.

        +
        +

        itemCategoryHashes are the preferred way of identifying types, we have retained + this enum for its convenience.

        +
        +
        +
        + +

        itemTypeAndTierDisplayName

        +
        itemTypeAndTierDisplayName: string
        + +
        +
        +

        It became a common enough pattern in our UI to show Item Type and Tier combined + into a single localized string that I'm just going to go ahead and start pre- + creating these for items.

        +
        +
        +
        +
        + +

        itemTypeDisplayName

        +
        itemTypeDisplayName: string
        + +
        +
        +

        The localized title/name of the item's type. This can be whatever the designers + want, and has no guarantee of consistency between items.

        +
        +
        +
        +
        + +

        links

        + + +
        +
        +

        If we added any help or informational URLs about this item, these will be those + links.

        +
        +
        +
        +
        + +

        Optional loreHash

        +
        loreHash: number
        + +
        +
        +

        If the item has any related Lore (DestinyLoreDefinition), this will be the hash + identifier you can use to look up the lore definition.

        +
        +

        Mapped to DestinyLoreDefinition in the manifest.

        +
        +
        +
        + +

        nonTransferrable

        +
        nonTransferrable: boolean
        + +
        +
        +

        The intrinsic transferability of an item.

        +
        +

        I hate that this boolean is negative - but there's a reason.

        +

        Just because an item is intrinsically transferrable doesn't mean that it can be + transferred, and we don't want to imply that this is the only source of that + transferability.

        +
        +
        +
        + +

        objectives

        + + +
        +
        +

        If this item has Objectives (extra tasks that can be accomplished related to the + item... most frequently when the item is a Quest Step and the Objectives need to + be completed to move on to the next Quest Step), this block will be non-null and + the objectives defined herein.

        +
        +
        +
        +
        + +

        perks

        + + +
        +
        +

        If the item has any intrinsic Perks (Perks that it will provide regardless of + Sockets, Talent Grid, and other transitory state), they will be defined here.

        +
        +
        +
        +
        + +

        plug

        + + +
        +
        +

        If this item is a Plug, this will be non-null and the info defined herein. See + DestinyItemPlugDefinition for more information.

        +
        +
        +
        +
        + +

        preview

        + + +
        +
        +

        If this item can be Used or Acquired to gain other items (for instance, how + Eververse Boxes can be consumed to get items from the box), this block will be + non-null and will give summary information for the items that can be acquired.

        +
        +
        +
        +
        + +

        quality

        + + +
        +
        +

        If this item can have a level or stats, this block will be non-null and will be + populated with default quality (item level, "quality", and infusion) data. See + the block for more details, there's often less upfront information in D2 so you' + ll want to be aware of how you use quality and item level on the definition + level now.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        sack

        + + +
        +
        +

        If this item is a "reward sack" that can be opened to provide other items, this + will be non-null and the properties of the sack contained herein.

        +
        +
        +
        +
        + +

        screenshot

        +
        screenshot: string
        + +
        +
        +

        If we were able to acquire an in-game screenshot for the item, the path to that + screenshot will be returned here. Note that not all items have screenshots: + particularly not any non-equippable items.

        +
        +
        +
        +
        + +

        secondaryIcon

        +
        secondaryIcon: string
        + +
        +
        +

        A secondary icon associated with the item. Currently this is used in very + context specific applications, such as Emblem Nameplates.

        +
        +
        +
        +
        + +

        secondaryOverlay

        +
        secondaryOverlay: string
        + +
        +
        +

        Pulled from the secondary icon, this is the "secondary background" of the + secondary icon. Confusing? Sure, that's why I call it "overlay" here: because as + far as it's been used thus far, it has been for an optional overlay image. We'll + see if that holds up, but at least for now it explains what this image is a bit + better.

        +
        +
        +
        +
        + +

        secondarySpecial

        +
        secondarySpecial: string
        + +
        +
        +

        Pulled from the Secondary Icon, this is the "special" background for the item. + For Emblems, this is the background image used on the Details view: but it need + not be limited to that for other types of items.

        +
        +
        +
        +
        + +

        setData

        + + +
        +
        +

        If this item is a quest, this block will be non-null. In practice, I wish I had + called this the Quest block, but at the time it wasn't clear to me whether it + would end up being used for purposes other than quests. It will contain data + about the steps in the quest, and mechanics we can use for displaying and + tracking the quest.

        +
        +
        +
        +
        + +

        sockets

        + + +
        +
        +

        If this item has any Sockets, this will be non-null and the individual sockets + on the item will be defined herein.

        +
        +
        +
        +
        + +

        sourceData

        + + +
        +
        +

        If this item has a known source, this block will be non-null and populated with + source information. Unfortunately, at this time we are not generating sources: + that is some aggressively manual work which we didn't have time for, and I'm + hoping to get back to at some point in the future.

        +
        +
        +
        +
        + +

        specialItemType

        +
        specialItemType: SpecialItemType
        + +
        +
        +

        In Destiny 1, we identified some items as having particular categories that we'd + like to know about for various internal logic purposes. These are defined in + SpecialItemType, and while these days the itemCategoryHashes are the preferred + way of identifying types, we have retained this enum for its convenience.

        +
        +
        +
        +
        + +

        stats

        + + +
        +
        +

        If this item can have stats (such as a weapon, armor, or vehicle), this block + will be non-null and populated with the stats found on the item.

        +
        +
        +
        +
        + +

        summary

        + + +
        +
        +

        Summary data about the item.

        +
        +
        +
        +
        + +

        Optional summaryItemHash

        +
        summaryItemHash: number
        + +
        +
        +

        There are times when the game will show you a "summary/vague" version of an item

        +
          +
        • such as a description of its type represented as a + DestinyInventoryItemDefinition - rather than display the item itself.
        • +
        +
        +

        This happens sometimes when summarizing possible rewards in a tooltip. This is + the item displayed instead, if it exists.

        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        talentGrid

        + + +
        +
        +

        If the item has a Talent Grid, this will be non-null and the properties of the + grid defined herein. Note that, while many items still have talent grids, the + only ones with meaningful Nodes still on them will be Subclass/"Build" items.

        +
        +
        +
        +
        + +

        tooltipStyle

        +
        tooltipStyle: string
        + +
        +
        +

        An identifier that the game UI uses to determine what type of tooltip to show + for the item. These have no corresponding definitions that BNet can link to: so + it'll be up to you to interpret and display your UI differently according to + these styles (or ignore it).

        +
        +
        +
        +
        + +

        translationBlock

        + + +
        +
        +

        If this item can be rendered, this block will be non-null and will be populated + with rendering information.

        +
        +
        +
        +
        + +

        uiItemDisplayStyle

        +
        uiItemDisplayStyle: string
        + +
        +
        +

        A string identifier that the game's UI uses to determine how the item should be + rendered in inventory screens and the like. This could really be anything - at + the moment, we don't have the time to really breakdown and maintain all the + possible strings this could be, partly because new ones could be added ad hoc. + But if you want to use it to dictate your own UI, or look for items with a + certain display style, go for it!

        +
        +
        +
        +
        + +

        value

        + + +
        +
        +

        The conceptual "Value" of an item, if any was defined. See the + DestinyItemValueBlockDefinition for more details.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyinventoryitemstatdefinition.html b/docs/interfaces/destinyinventoryitemstatdefinition.html new file mode 100644 index 0000000..3868d64 --- /dev/null +++ b/docs/interfaces/destinyinventoryitemstatdefinition.html @@ -0,0 +1,281 @@ + + + + + + DestinyInventoryItemStatDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyInventoryItemStatDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Defines a specific stat value on an item, and the minimum/maximum range that we + could compute for the item based on our heuristics for how the item might be + generated.

        +
        +

        Not guaranteed to match real-world instances of the item, but should hopefully + at least be close. If it's not close, let us know on the Bungie API forums.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyInventoryItemStatDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        maximum

        +
        maximum: number
        + +
        +
        +

        The maximum possible value for this stat that we think the item can roll.

        +
        +

        WARNING: In Destiny 1, this field was calculated using the potential stat rolls + on the item's talent grid. In Destiny 2, items no longer have meaningful talent + grids and instead have sockets: but the calculation of this field was never + altered to adapt to this change. As such, this field should be considered + deprecated until we can address this oversight.

        +
        +
        +
        + +

        minimum

        +
        minimum: number
        + +
        +
        +

        The minimum possible value for this stat that we think the item can roll.

        +
        +
        +
        +
        + +

        statHash

        +
        statHash: number
        + +
        +
        +

        The hash for the DestinyStatDefinition representing this stat.

        +
        +

        Mapped to DestinyStatDefinition in the manifest.

        +
        +
        +
        + +

        value

        +
        value: number
        + +
        +
        +

        This value represents the stat value assuming the minimum possible roll but + accounting for any mandatory bonuses that should be applied to the stat on item + creation.

        +
        +

        In Destiny 1, this was different from the "minimum" value because there were + certain conditions where an item could be theoretically lower level/value than + the initial roll.

        +

        In Destiny 2, this is not possible unless Talent Grids begin to be used again + for these purposes or some other system change occurs... thus in practice, value + and minimum should be the same in Destiny 2. Good riddance.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemactionblockdefinition.html b/docs/interfaces/destinyitemactionblockdefinition.html new file mode 100644 index 0000000..a123ead --- /dev/null +++ b/docs/interfaces/destinyitemactionblockdefinition.html @@ -0,0 +1,463 @@ + + + + + + DestinyItemActionBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemActionBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If an item can have an action performed on it (like "Dismantle"), it will be + defined here if you care.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemActionBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        actionTypeLabel

        +
        actionTypeLabel: string
        + +
        +
        +

        The internal identifier for the action.

        +
        +
        +
        +
        + +

        consumeEntireStack

        +
        consumeEntireStack: boolean
        + +
        +
        +

        If true, the entire stack is deleted when the action completes.

        +
        +
        +
        +
        + +

        deleteOnAction

        +
        deleteOnAction: boolean
        + +
        +
        +

        If true, the item is deleted when the action completes.

        +
        +
        +
        +
        + +

        isPositive

        +
        isPositive: boolean
        + +
        +
        +

        The content has this property, however it's not entirely clear how it is used.

        +
        +
        +
        +
        + +

        overlayIcon

        +
        overlayIcon: string
        + +
        +
        +

        The icon associated with the overlay screen for the action, if any.

        +
        +
        +
        +
        + +

        overlayScreenName

        +
        overlayScreenName: string
        + +
        +
        +

        If the action has an overlay screen associated with it, this is the name of that + screen. Unfortunately, we cannot return the screen's data itself.

        +
        +
        +
        +
        + +

        progressionRewards

        + + +
        +
        +

        If performing this action earns you Progression, this is the list of + progressions and values granted for those progressions by performing this action.

        +
        +
        +
        +
        + +

        requiredCooldownHash

        +
        requiredCooldownHash: number
        + +
        +
        +

        The identifier hash for the Cooldown associated with this action. We have not + pulled this data yet for you to have more data to use for cooldowns.

        +
        +
        +
        +
        + +

        requiredCooldownSeconds

        +
        requiredCooldownSeconds: number
        + +
        +
        +

        The number of seconds to delay before allowing this action to be performed again.

        +
        +
        +
        +
        + +

        requiredItems

        + + +
        +
        +

        If the action requires other items to exist or be destroyed, this is the list of + those items and requirements.

        +
        +
        +
        +
        + +

        requiredLocation

        +
        requiredLocation: string
        + +
        +
        +

        Theoretically, an item could have a localized string for a hint about the + location in which the action should be performed. In practice, no items yet have + this property.

        +
        +
        +
        +
        + +

        useOnAcquire

        +
        useOnAcquire: boolean
        + +
        +
        +

        If true, this action will be performed as soon as you earn this item. Some + rewards work this way, providing you a single item to pick up from a reward- + granting vendor in-game and then immediately consuming itself to provide you + multiple items.

        +
        +
        +
        +
        + +

        verbDescription

        +
        verbDescription: string
        + +
        +
        +

        Localized text describing the action being performed.

        +
        +
        +
        +
        + +

        verbName

        +
        verbName: string
        + +
        +
        +

        Localized text for the verb of the action being performed.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemactionrequest.html b/docs/interfaces/destinyitemactionrequest.html new file mode 100644 index 0000000..c2f8fc3 --- /dev/null +++ b/docs/interfaces/destinyitemactionrequest.html @@ -0,0 +1,222 @@ + + + + + + DestinyItemActionRequest | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemActionRequest

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemActionRequest +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        characterId

        +
        characterId: string
        + +
        +
        + +

        itemId

        +
        itemId: string
        + +
        +
        + +

        membershipType

        +
        membershipType: BungieMembershipType
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemactionrequireditemdefinition.html b/docs/interfaces/destinyitemactionrequireditemdefinition.html new file mode 100644 index 0000000..64e6a6e --- /dev/null +++ b/docs/interfaces/destinyitemactionrequireditemdefinition.html @@ -0,0 +1,249 @@ + + + + + + DestinyItemActionRequiredItemDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemActionRequiredItemDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The definition of an item and quantity required in a character's inventory in + order to perform an action.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemActionRequiredItemDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        count

        +
        count: number
        + +
        +
        +

        The minimum quantity of the item you have to have.

        +
        +
        +
        +
        + +

        deleteOnAction

        +
        deleteOnAction: boolean
        + +
        +
        +

        If true, the item/quantity will be deleted from your inventory when the action + is performed. Otherwise, you'll retain these required items after the action is + complete.

        +
        +
        +
        +
        + +

        itemHash

        +
        itemHash: number
        + +
        +
        +

        The hash identifier of the item you need to have. Use it to look up the + DestinyInventoryItemDefinition for more info.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemcategorydefinition.html b/docs/interfaces/destinyitemcategorydefinition.html new file mode 100644 index 0000000..b1e7f16 --- /dev/null +++ b/docs/interfaces/destinyitemcategorydefinition.html @@ -0,0 +1,549 @@ + + + + + + DestinyItemCategoryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemCategoryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        In an attempt to categorize items by type, usage, and other interesting + properties, we created DestinyItemCategoryDefinition: information about types + that is assembled using a set of heuristics that examine the properties of an + item such as what inventory bucket it's in, its item type name, and whether it + has or is missing certain blocks of data.

        +
        +

        This heuristic is imperfect, however. If you find an item miscategorized, let us + know on the Bungie API forums!

        +

        We then populate all of the categories that we think an item belongs to in its + DestinyInventoryItemDefinition.itemCategoryHashes property. You can use that to + provide your own custom item filtering, sorting, aggregating... go nuts on it! + And let us know if you see more categories that you wish would be added!

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemCategoryDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        deprecated

        +
        deprecated: boolean
        + +
        +
        +

        If True, this category has been deprecated: it may have no items left, or there + may be only legacy items that remain in it which are no longer relevant to the + game.

        +
        +
        +
        +
        + +

        displayProperties

        + + +
        +
        + +

        grantDestinyClass

        +
        grantDestinyClass: DestinyClass
        + +
        +
        +

        If an item belongs to this category, it will also get this class restriction + enum value.

        +
        +

        See the other "grant"-prefixed properties on this definition for my color + commentary.

        +
        +
        +
        + +

        grantDestinyItemType

        +
        grantDestinyItemType: DestinyItemType
        + +
        +
        +

        If an item belongs to this category, it will also receive this item type. This + is now how DestinyItemType is populated for items: it used to be an even jankier + process, but that's a story that requires more alcohol.

        +
        +
        +
        +
        + +

        grantDestinySubType

        +
        grantDestinySubType: DestinyItemSubType
        + +
        +
        +

        If an item belongs to this category, it will also receive this subtype enum + value.

        +
        +

        I know what you're thinking - what if it belongs to multiple categories that + provide sub-types?

        +

        The last one processed wins, as is the case with all of these "grant" enums. Now + you can see one reason why we moved away from these enums... but they're so + convenient when they work, aren't they?

        +
        +
        +
        + +

        groupCategoryOnly

        +
        groupCategoryOnly: boolean
        + +
        +
        +

        If true, this category is only used for grouping, and should not be evaluated + with its own checks. Rather, the item only has this category if it has one of + its child categories.

        +
        +
        +
        +
        + +

        groupedCategoryHashes

        +
        groupedCategoryHashes: number[]
        + +
        +
        +

        If this category is a "parent" category of other categories, those children will + have their hashes listed in rendering order here, and can be looked up using + these hashes against DestinyItemCategoryDefinition.

        +
        +

        In this way, you can build up a visual hierarchy of item categories. That's what + we did, and you can do it too. I believe in you. Yes, you, Carl.

        +

        (I hope someone named Carl reads this someday)

        +

        Mapped to DestinyItemCategoryDefinition in the manifest.

        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        itemTypeRegex

        +
        itemTypeRegex: string
        + +
        +
        +

        The janky regular expression we used against the item type to try and discern + whether the item belongs to this category.

        +
        +
        +
        +
        + +

        itemTypeRegexNot

        +
        itemTypeRegexNot: string
        + +
        +
        +

        If the item type matches this janky regex, it does not belong to this category.

        +
        +
        +
        +
        + +

        originBucketIdentifier

        +
        originBucketIdentifier: string
        + +
        +
        +

        If the item belongs to this bucket, it does belong to this category.

        +
        +
        +
        +
        + +

        parentCategoryHashes

        +
        parentCategoryHashes: number[]
        + +
        +
        +

        All item category hashes of "parent" categories: categories that contain this as + a child through the hierarchy of groupedCategoryHashes. It's a bit redundant, + but having this child-centric list speeds up some calculations.

        +
        +
        +
        +
        + +

        plugCategoryIdentifier

        +
        plugCategoryIdentifier: string
        + +
        +
        +

        If the item is a plug, this is the identifier we expect to find associated with + it if it is in this category.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        shortTitle

        +
        shortTitle: string
        + +
        +
        +

        A shortened version of the title. The reason why we have this is because the + Armory in German had titles that were too long to display in our UI, so these + were localized abbreviated versions of those categories. The property still + exists today, even though the Armory doesn't exist for D2... yet.

        +
        +
        +
        +
        + +

        visible

        +
        visible: boolean
        + +
        +
        +

        If True, this category should be visible in UI. Sometimes we make categories + that we don't think are interesting externally. It's up to you if you want to + skip on showing them.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemchangeresponse.html b/docs/interfaces/destinyitemchangeresponse.html new file mode 100644 index 0000000..d759d91 --- /dev/null +++ b/docs/interfaces/destinyitemchangeresponse.html @@ -0,0 +1,232 @@ + + + + + + DestinyItemChangeResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemChangeResponse

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemChangeResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        addedInventoryItems

        +
        addedInventoryItems: DestinyItemComponent[]
        + +
        +
        +

        Items that appeared in the inventory possibly as a result of an action.

        +
        +
        +
        +
        + +

        item

        + + +
        +
        + +

        removedInventoryItems

        +
        removedInventoryItems: DestinyItemComponent[]
        + +
        +
        +

        Items that disappeared from the inventory possibly as a result of an action.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemcomponent.html b/docs/interfaces/destinyitemcomponent.html new file mode 100644 index 0000000..e288393 --- /dev/null +++ b/docs/interfaces/destinyitemcomponent.html @@ -0,0 +1,420 @@ + + + + + + DestinyItemComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The base item component, filled with properties that are generally useful to + know in any item request or that don't feel worthwhile to put in their own + component.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemComponent +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        bindStatus

        +
        bindStatus: ItemBindStatus
        + +
        +
        +

        If the item is bound to a location, it will be specified in this enum.

        +
        +
        +
        +
        + +

        bucketHash

        +
        bucketHash: number
        + +
        +
        +

        The hash identifier for the specific inventory bucket in which the item is + located.

        +
        +

        Mapped to DestinyInventoryBucketDefinition in the manifest.

        +
        +
        +
        + +

        Optional expirationDate

        +
        expirationDate: string
        + +
        +
        +

        If the item can expire, this is the date at which it will/did expire.

        +
        +
        +
        +
        + +

        itemHash

        +
        itemHash: number
        + +
        +
        +

        The identifier for the item's definition, which is where most of the useful + static information for the item can be found.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        Optional itemInstanceId

        +
        itemInstanceId: string
        + +
        +
        +

        If the item is instanced, it will have an instance ID. Lack of an instance ID + implies that the item has no distinct local qualities aside from stack size.

        +
        +
        +
        +
        + +

        location

        +
        location: ItemLocation
        + +
        +
        +

        An easy reference for where the item is located. Redundant if you got the item + from an Inventory, but useful when making detail calls on specific items.

        +
        +
        +
        +
        + +

        lockable

        +
        lockable: boolean
        + +
        +
        +

        If the item can be locked, this will indicate that state.

        +
        +
        +
        +
        + +

        Optional overrideStyleItemHash

        +
        overrideStyleItemHash: number
        + +
        +
        +

        If populated, this is the hash of the item whose icon (and other secondary + styles, but not the human readable strings) should override whatever icons/ + styles are on the item being sold.

        +
        +

        If you don't do this, certain items whose styles are being overridden by + socketed items - such as the "Recycle Shader" item - would show whatever their + default icon/style is, and it wouldn't be pretty or look accurate.

        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        quantity

        +
        quantity: number
        + +
        +
        +

        The quantity of the item in this stack. Note that Instanced items cannot stack. + If an instanced item, this value will always be 1 (as the stack has exactly one + item in it)

        +
        +
        +
        +
        + +

        state

        +
        state: ItemState
        + +
        +
        +

        A flags enumeration indicating the transient/custom states of the item that + affect how it is rendered: whether it's tracked or locked for example, or + whether it has a masterwork plug inserted.

        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        + +

        transferStatus

        +
        transferStatus: TransferStatuses
        + +
        +
        +

        If there is a known error state that would cause this item to not be + transferable, this Flags enum will indicate all of those error states. Otherwise, + it will be 0 (CanTransfer).

        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemcomponentsetofint32.html b/docs/interfaces/destinyitemcomponentsetofint32.html new file mode 100644 index 0000000..f018776 --- /dev/null +++ b/docs/interfaces/destinyitemcomponentsetofint32.html @@ -0,0 +1,292 @@ + + + + + + DestinyItemComponentSetOfint32 | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemComponentSetOfint32

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemComponentSetOfint32 +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        instances

        + + +
        +
        + +

        objectives

        + + +
        +
        + +

        perks

        + + +
        +
        + +

        plugStates

        + + +
        +
        + +

        renderData

        + + +
        +
        + +

        sockets

        + + +
        +
        + +

        stats

        + + +
        +
        + +

        talentGrids

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemcomponentsetofint64.html b/docs/interfaces/destinyitemcomponentsetofint64.html new file mode 100644 index 0000000..6f05c8a --- /dev/null +++ b/docs/interfaces/destinyitemcomponentsetofint64.html @@ -0,0 +1,292 @@ + + + + + + DestinyItemComponentSetOfint64 | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemComponentSetOfint64

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemComponentSetOfint64 +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        instances

        + + +
        +
        + +

        objectives

        + + +
        +
        + +

        perks

        + + +
        +
        + +

        plugStates

        + + +
        +
        + +

        renderData

        + + +
        +
        + +

        sockets

        + + +
        +
        + +

        stats

        + + +
        +
        + +

        talentGrids

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemcomponentsetofuint32.html b/docs/interfaces/destinyitemcomponentsetofuint32.html new file mode 100644 index 0000000..6c12711 --- /dev/null +++ b/docs/interfaces/destinyitemcomponentsetofuint32.html @@ -0,0 +1,292 @@ + + + + + + DestinyItemComponentSetOfuint32 | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemComponentSetOfuint32

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemComponentSetOfuint32 +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        instances

        + + +
        +
        + +

        objectives

        + + +
        +
        + +

        perks

        + + +
        +
        + +

        plugStates

        + + +
        +
        + +

        renderData

        + + +
        +
        + +

        sockets

        + + +
        +
        + +

        stats

        + + +
        +
        + +

        talentGrids

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemcreationentryleveldefinition.html b/docs/interfaces/destinyitemcreationentryleveldefinition.html new file mode 100644 index 0000000..7cee8a6 --- /dev/null +++ b/docs/interfaces/destinyitemcreationentryleveldefinition.html @@ -0,0 +1,201 @@ + + + + + + DestinyItemCreationEntryLevelDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemCreationEntryLevelDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        An overly complicated wrapper for the item level at which the item should spawn.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemCreationEntryLevelDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        level

        +
        level: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemgearsetblockdefinition.html b/docs/interfaces/destinyitemgearsetblockdefinition.html new file mode 100644 index 0000000..9fa0682 --- /dev/null +++ b/docs/interfaces/destinyitemgearsetblockdefinition.html @@ -0,0 +1,229 @@ + + + + + + DestinyItemGearsetBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemGearsetBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If an item has a related gearset, this is the list of items in that set, and an + unlock expression that evaluates to a number representing the progress toward + gearset completion (a very rare use for unlock expressions!)

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemGearsetBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        itemList

        +
        itemList: number[]
        + +
        +
        +

        The list of hashes for items in the gearset. Use them to look up + DestinyInventoryItemDefinition entries for the items in the set.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        trackingValueMax

        +
        trackingValueMax: number
        + +
        +
        +

        The maximum possible number of items that can be collected.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyiteminstancecomponent.html b/docs/interfaces/destinyiteminstancecomponent.html new file mode 100644 index 0000000..4b76d96 --- /dev/null +++ b/docs/interfaces/destinyiteminstancecomponent.html @@ -0,0 +1,404 @@ + + + + + + DestinyItemInstanceComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemInstanceComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If an item is "instanced", this will contain information about the item's + instance that doesn't fit easily into other components. One might say this is + the "essential" instance data for the item.

        +
        +

        Items are instanced if they require information or state that can vary. For + instance, weapons are Instanced: they are given a unique identifier, uniquely + generated stats, and can have their properties altered. Non-instanced items have + none of these things: for instance, Glimmer has no unique properties aside from + how much of it you own.

        +

        You can tell from an item's definition whether it will be instanced or not by + looking at the DestinyInventoryItemDefinition's definition.inventory. + isInstanceItem property.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemInstanceComponent +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        canEquip

        +
        canEquip: boolean
        + +
        +
        +

        If this is an equippable item, you can check it here. There are permanent as + well as transitory reasons why an item might not be able to be equipped: check + cannotEquipReason for details.

        +
        +
        +
        +
        + +

        cannotEquipReason

        +
        cannotEquipReason: EquipFailureReason
        + +
        +
        +

        If you cannot equip the item, this is a flags enum that enumerates all of the + reasons why you couldn't equip the item. You may need to refine your UI further + by using unlockHashesRequiredToEquip and equipRequiredLevel.

        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        + +

        damageType

        +
        damageType: DamageType
        + +
        +
        +

        If the item has a damage type, this is the item's current damage type.

        +
        +
        +
        +
        + +

        Optional damageTypeHash

        +
        damageTypeHash: number
        + +
        +
        +

        The current damage type's hash, so you can look up localized info and icons for + it.

        +
        +

        Mapped to DestinyDamageTypeDefinition in the manifest.

        +
        +
        +
        + +

        equipRequiredLevel

        +
        equipRequiredLevel: number
        + +
        +
        +

        If the item cannot be equipped until you reach a certain level, that level will + be reflected here.

        +
        +
        +
        +
        + +

        isEquipped

        +
        isEquipped: boolean
        + +
        +
        +

        Is the item currently equipped on the given character?

        +
        +
        +
        +
        + +

        itemLevel

        +
        itemLevel: number
        + +
        +
        +

        The Item's "Level" has the most significant bearing on its stats, such as Light + and Power.

        +
        +
        +
        +
        + +

        primaryStat

        +
        primaryStat: DestinyStat
        + +
        +
        +

        The item stat that we consider to be "primary" for the item. For instance, this + would be "Attack" for Weapons or "Defense" for armor.

        +
        +
        +
        +
        + +

        quality

        +
        quality: number
        + +
        +
        +

        The "Quality" of the item has a lesser - but still impactful - bearing on stats + like Light and Power.

        +
        +
        +
        +
        + +

        unlockHashesRequiredToEquip

        +
        unlockHashesRequiredToEquip: number[]
        + +
        +
        +

        Sometimes, there are limitations to equipping that are represented by character- + level flags called "unlocks".

        +
        +

        This is a list of flags that they need in order to equip the item that the + character has not met. Use these to look up the descriptions to show in your UI + by looking up the relevant DestinyUnlockDefinitions for the hashes.

        +

        Mapped to DestinyUnlockDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemintrinsicsocketentrydefinition.html b/docs/interfaces/destinyitemintrinsicsocketentrydefinition.html new file mode 100644 index 0000000..76d30e9 --- /dev/null +++ b/docs/interfaces/destinyitemintrinsicsocketentrydefinition.html @@ -0,0 +1,253 @@ + + + + + + DestinyItemIntrinsicSocketEntryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemIntrinsicSocketEntryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents a socket that has a plug associated with it intrinsically. This is + useful for situations where the weapon needs to have a visual plug/Mod on it, + but that plug/Mod should never change.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemIntrinsicSocketEntryDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        defaultVisible

        +
        defaultVisible: boolean
        + +
        +
        +

        If true, then this socket is visible in the item's "default" state. If you have + an instance, you should always check the runtime state, as that can override + this visibility setting: but if you're looking at the item on a conceptual level, + this property can be useful for hiding data such as legacy sockets - which + remain defined on items for infrastructure purposes, but can be confusing for + users to see.

        +
        +
        +
        +
        + +

        plugItemHash

        +
        plugItemHash: number
        + +
        +
        +

        Indicates the plug that is intrinsically inserted into this socket.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        socketTypeHash

        +
        socketTypeHash: number
        + +
        +
        +

        Indicates the type of this intrinsic socket.

        +
        +

        Mapped to DestinySocketTypeDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyiteminventoryblockdefinition.html b/docs/interfaces/destinyiteminventoryblockdefinition.html new file mode 100644 index 0000000..bad9e53 --- /dev/null +++ b/docs/interfaces/destinyiteminventoryblockdefinition.html @@ -0,0 +1,428 @@ + + + + + + DestinyItemInventoryBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemInventoryBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If the item can exist in an inventory - the overwhelming majority of them can + and do - then this is the basic properties regarding the item's relationship + with the inventory.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemInventoryBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        bucketTypeHash

        +
        bucketTypeHash: number
        + +
        +
        +

        The hash identifier for the DestinyInventoryBucketDefinition to which this item + belongs. I should have named this "bucketHash", but too many things refer to it + now. Sigh.

        +
        +

        Mapped to DestinyInventoryBucketDefinition in the manifest.

        +
        +
        +
        + +

        expirationTooltip

        +
        expirationTooltip: string
        + +
        +
        +

        The tooltip message to show, if any, when the item expires.

        +
        +
        +
        +
        + +

        expiredInActivityMessage

        +
        expiredInActivityMessage: string
        + +
        +
        +

        If the item expires while playing in an activity, we show a different message.

        +
        +
        +
        +
        + +

        expiredInOrbitMessage

        +
        expiredInOrbitMessage: string
        + +
        +
        +

        If the item expires in orbit, we show a... more different message. ("Consummate + V's, consummate!")

        +
        +
        +
        +
        + +

        isInstanceItem

        +
        isInstanceItem: boolean
        + +
        +
        +

        If TRUE, this item is instanced. Otherwise, it is a generic item that merely has + a quantity in a stack (like Glimmer).

        +
        +
        +
        +
        + +

        maxStackSize

        +
        maxStackSize: number
        + +
        +
        +

        The maximum quantity of this item that can exist in a stack.

        +
        +
        +
        +
        + +

        recoveryBucketTypeHash

        +
        recoveryBucketTypeHash: number
        + +
        +
        +

        If the item is picked up by the lost loot queue, this is the hash identifier for + the DestinyInventoryBucketDefinition into which it will be placed. Again, I + should have named this recoveryBucketHash instead.

        +
        +

        Mapped to DestinyInventoryBucketDefinition in the manifest.

        +
        +
        +
        + +

        stackUniqueLabel

        +
        stackUniqueLabel: string
        + +
        +
        +

        If this string is populated, you can't have more than one stack with this label + in a given inventory. Note that this is different from the equipping block's + unique label, which is used for equipping uniqueness.

        +
        +
        +
        +
        + +

        suppressExpirationWhenObjectivesComplete

        +
        suppressExpirationWhenObjectivesComplete: boolean
        + +
        +
        + +

        tierType

        +
        tierType: TierType
        + +
        +
        +

        The enumeration matching the tier type of the item to known values, again for + convenience sake.

        +
        +
        +
        +
        + +

        tierTypeHash

        +
        tierTypeHash: number
        + +
        +
        +

        The hash identifier for the Tier Type of the item, use to look up its + DestinyItemTierTypeDefinition if you need to show localized data for the item's + tier.

        +
        +

        Mapped to DestinyItemTierTypeDefinition in the manifest.

        +
        +
        +
        + +

        tierTypeName

        +
        tierTypeName: string
        + +
        +
        +

        The localized name of the tier type, which is a useful shortcut so you don't + have to look up the definition every time. However, it's mostly a holdover from + days before we had a DestinyItemTierTypeDefinition to refer to.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyiteminvestmentstatdefinition.html b/docs/interfaces/destinyiteminvestmentstatdefinition.html new file mode 100644 index 0000000..2d925fa --- /dev/null +++ b/docs/interfaces/destinyiteminvestmentstatdefinition.html @@ -0,0 +1,257 @@ + + + + + + DestinyItemInvestmentStatDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemInvestmentStatDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents a "raw" investment stat, before calculated stats are calculated and + before any DestinyStatGroupDefinition is applied to transform the stat into + something closer to what you see in-game.

        +
        +

        Because these won't match what you see in-game, consider carefully whether you + really want to use these stats. I have left them in case someone can do + something useful or interesting with the pre-processed statistics.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemInvestmentStatDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        isConditionallyActive

        +
        isConditionallyActive: boolean
        + +
        +
        +

        If this is true, the stat will only be applied on the item in certain game state + conditions, and we can't know statically whether or not this stat will be + applied. Check the "live" API data instead for whether this value is being + applied on a specific instance of the item in question, and you can use this to + decide whether you want to show the stat on the generic view of the item, or + whether you want to show some kind of caveat or warning about the stat value + being conditional on game state.

        +
        +
        +
        +
        + +

        statTypeHash

        +
        statTypeHash: number
        + +
        +
        +

        The hash identifier for the DestinyStatDefinition defining this stat.

        +
        +

        Mapped to DestinyStatDefinition in the manifest.

        +
        +
        +
        + +

        value

        +
        value: number
        + +
        +
        +

        The raw "Investment" value for the stat, before transformations are performed to + turn this raw stat into stats that are displayed in the game UI.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemobjectiveblockdefinition.html b/docs/interfaces/destinyitemobjectiveblockdefinition.html new file mode 100644 index 0000000..51eaf72 --- /dev/null +++ b/docs/interfaces/destinyitemobjectiveblockdefinition.html @@ -0,0 +1,376 @@ + + + + + + DestinyItemObjectiveBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemObjectiveBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        An item can have objectives on it. In practice, these are the exclusive purview + of "Quest Step" items: DestinyInventoryItemDefinitions that represent a specific + step in a Quest.

        +
        +

        Quest steps have 1:M objectives that we end up processing and returning in live + data as DestinyQuestStatus data, and other useful information.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemObjectiveBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        displayActivityHashes

        +
        displayActivityHashes: number[]
        + +
        +
        +

        For every entry in objectiveHashes, there is a corresponding entry in this array + at the same index. If the objective is meant to be associated with a specific + DestinyActivityDefinition, there will be a valid hash at that index. Otherwise, + it will be invalid (0).

        +
        +

        Rendered somewhat obsolete by perObjectiveDisplayProperties, which currently has + much the same information but may end up with more info in the future.

        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        narrative

        +
        narrative: string
        + +
        +
        +

        The localized string for narrative text related to this quest step, if any.

        +
        +
        +
        +
        + +

        objectiveHashes

        +
        objectiveHashes: number[]
        + +
        +
        +

        The hashes to Objectives (DestinyObjectiveDefinition) that are part of this + Quest Step, in the order that they should be rendered.

        +
        +

        Mapped to DestinyObjectiveDefinition in the manifest.

        +
        +
        +
        + +

        objectiveVerbName

        +
        objectiveVerbName: string
        + +
        +
        +

        The localized string describing an action to be performed associated with the + objectives, if any.

        +
        +
        +
        +
        + +

        perObjectiveDisplayProperties

        +
        perObjectiveDisplayProperties: DestinyObjectiveDisplayProperties[]
        + +
        +
        +

        One entry per Objective on the item, it will have related display information.

        +
        +
        +
        +
        + +

        questTypeHash

        +
        questTypeHash: number
        + +
        +
        +

        A hashed value for the questTypeIdentifier, because apparently I like to be + redundant.

        +
        +
        +
        +
        + +

        questTypeIdentifier

        +
        questTypeIdentifier: string
        + +
        +
        +

        The identifier for the type of quest being performed, if any. Not associated + with any fixed definition, yet.

        +
        +
        +
        +
        + +

        questlineItemHash

        +
        questlineItemHash: number
        + +
        +
        +

        The hash for the DestinyInventoryItemDefinition representing the Quest to which + this Quest Step belongs.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        requireFullObjectiveCompletion

        +
        requireFullObjectiveCompletion: boolean
        + +
        +
        +

        If True, all objectives must be completed for the step to be completed. If False, + any one objective can be completed for the step to be completed.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemobjectivescomponent.html b/docs/interfaces/destinyitemobjectivescomponent.html new file mode 100644 index 0000000..519f6f2 --- /dev/null +++ b/docs/interfaces/destinyitemobjectivescomponent.html @@ -0,0 +1,253 @@ + + + + + + DestinyItemObjectivesComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemObjectivesComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Items can have objectives and progression. When you request this block, you will + obtain information about any Objectives and progression tied to this item.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemObjectivesComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        Optional dateCompleted

        +
        dateCompleted: string
        + +
        +
        +

        If we have any information on when these objectives were completed, this will be + the date of that completion. This won't be on many items, but could be + interesting for some items that do store this information.

        +
        +
        +
        +
        + +

        flavorObjective

        +
        flavorObjective: DestinyObjectiveProgress
        + +
        +
        +

        I may regret naming it this way - but this represents when an item has an + objective that doesn't serve a beneficial purpose, but rather is used for " + flavor" or additional information. For instance, when Emblems track specific + stats, those stats are represented as Objectives on the item.

        +
        +
        +
        +
        + +

        objectives

        + + +
        +
        +

        If the item has a hard association with objectives, your progress on them will + be defined here.

        +
        +

        Objectives are our standard way to describe a series of tasks that have to be + completed for a reward.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitempeerview.html b/docs/interfaces/destinyitempeerview.html new file mode 100644 index 0000000..24d6ec8 --- /dev/null +++ b/docs/interfaces/destinyitempeerview.html @@ -0,0 +1,228 @@ + + + + + + DestinyItemPeerView | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemPeerView

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Bare minimum summary information for an item, for the sake of 3D rendering the + item.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemPeerView +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        dyes

        +
        dyes: DyeReference[]
        + +
        +
        +

        The list of dyes that have been applied to this item.

        +
        +
        +
        +
        + +

        itemHash

        +
        itemHash: number
        + +
        +
        +

        The hash identifier of the item in question. Use it to look up the + DestinyInventoryItemDefinition of the item for static rendering data.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemperkentrydefinition.html b/docs/interfaces/destinyitemperkentrydefinition.html new file mode 100644 index 0000000..cf49bed --- /dev/null +++ b/docs/interfaces/destinyitemperkentrydefinition.html @@ -0,0 +1,247 @@ + + + + + + DestinyItemPerkEntryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemPerkEntryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        An intrinsic perk on an item, and the requirements for it to be activated.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemPerkEntryDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        perkHash

        +
        perkHash: number
        + +
        +
        +

        A hash identifier for the DestinySandboxPerkDefinition being provided on the + item.

        +
        +

        Mapped to DestinySandboxPerkDefinition in the manifest.

        +
        +
        +
        + +

        perkVisibility

        +
        perkVisibility: ItemPerkVisibility
        + +
        +
        +

        Indicates whether this perk should be shown, or if it should be shown disabled.

        +
        +
        +
        +
        + +

        requirementDisplayString

        +
        requirementDisplayString: string
        + +
        +
        +

        If this perk is not active, this is the string to show for why it's not + providing its benefits.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemperkscomponent.html b/docs/interfaces/destinyitemperkscomponent.html new file mode 100644 index 0000000..81152ce --- /dev/null +++ b/docs/interfaces/destinyitemperkscomponent.html @@ -0,0 +1,212 @@ + + + + + + DestinyItemPerksComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemPerksComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Instanced items can have perks: benefits that the item bestows.

        +
        +

        These are related to DestinySandboxPerkDefinition, and sometimes - but not + always - have human readable info. When they do, they are the icons and text + that you see in an item's tooltip.

        +

        Talent Grids, Sockets, and the item itself can apply Perks, which are then + summarized here for your convenience.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemPerksComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        perks

        + + +
        +
        +

        The list of perks to display in an item tooltip - and whether or not they have + been activated.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemplug.html b/docs/interfaces/destinyitemplug.html new file mode 100644 index 0000000..e817ab2 --- /dev/null +++ b/docs/interfaces/destinyitemplug.html @@ -0,0 +1,310 @@ + + + + + + DestinyItemPlug | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemPlug

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemPlug +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        canInsert

        +
        canInsert: boolean
        + +
        +
        +

        If true, this plug has met all of its insertion requirements. Big if true.

        +
        +
        +
        +
        + +

        enableFailIndexes

        +
        enableFailIndexes: number[]
        + +
        +
        +

        If a plug is not enabled, this will be populated with indexes into the plug item + definition's plug.enabledRules property, so that you can show the reasons why it + is not enabled.

        +
        +

        This list will be empty if the plug is enabled.

        +
        +
        +
        + +

        enabled

        +
        enabled: boolean
        + +
        +
        +

        If true, this plug will provide its benefits while inserted.

        +
        +
        +
        +
        + +

        insertFailIndexes

        +
        insertFailIndexes: number[]
        + +
        +
        +

        If the plug cannot be inserted for some reason, this will have the indexes into + the plug item definition's plug.insertionRules property, so you can show the + reasons why it can't be inserted.

        +
        +

        This list will be empty if the plug can be inserted.

        +
        +
        +
        + +

        plugItemHash

        +
        plugItemHash: number
        + +
        +
        +

        The hash identifier of the DestinyInventoryItemDefinition that represents this + plug.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        plugObjectives

        +
        plugObjectives: DestinyObjectiveProgress[]
        + +
        +
        +

        Sometimes, Plugs may have objectives: these are often used for flavor and + display purposes, but they can be used for any arbitrary purpose (both + fortunately and unfortunately). Recently (with Season 2) they were expanded in + use to be used as the "gating" for whether the plug can be inserted at all. For + instance, a Plug might be tracking the number of PVP kills you have made. It + will use the parent item's data about that tracking status to determine what to + show, and will generally show it using the DestinyObjectiveDefinition's + progressDescription property. Refer to the plug's itemHash and objective + property for more information if you would like to display even more data.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemplugcomponent.html b/docs/interfaces/destinyitemplugcomponent.html new file mode 100644 index 0000000..ed7a082 --- /dev/null +++ b/docs/interfaces/destinyitemplugcomponent.html @@ -0,0 +1,322 @@ + + + + + + DestinyItemPlugComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemPlugComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Plugs are non-instanced items that can provide Stat and Perk benefits when + socketed into an instanced item. Items have Sockets, and Plugs are inserted into + Sockets.

        +
        +

        This component finds all items that are considered "Plugs" in your inventory, + and return information about the plug aside from any specific Socket into which + it could be inserted.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemPlugComponent +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        canInsert

        +
        canInsert: boolean
        + +
        +
        +

        If true, this plug has met all of its insertion requirements. Big if true.

        +
        +
        +
        +
        + +

        enableFailIndexes

        +
        enableFailIndexes: number[]
        + +
        +
        +

        If a plug is not enabled, this will be populated with indexes into the plug item + definition's plug.enabledRules property, so that you can show the reasons why it + is not enabled.

        +
        +

        This list will be empty if the plug is enabled.

        +
        +
        +
        + +

        enabled

        +
        enabled: boolean
        + +
        +
        +

        If true, this plug will provide its benefits while inserted.

        +
        +
        +
        +
        + +

        insertFailIndexes

        +
        insertFailIndexes: number[]
        + +
        +
        +

        If the plug cannot be inserted for some reason, this will have the indexes into + the plug item definition's plug.insertionRules property, so you can show the + reasons why it can't be inserted.

        +
        +

        This list will be empty if the plug can be inserted.

        +
        +
        +
        + +

        plugItemHash

        +
        plugItemHash: number
        + +
        +
        +

        The hash identifier of the DestinyInventoryItemDefinition that represents this + plug.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        plugObjectives

        +
        plugObjectives: DestinyObjectiveProgress[]
        + +
        +
        +

        Sometimes, Plugs may have objectives: these are often used for flavor and + display purposes, but they can be used for any arbitrary purpose (both + fortunately and unfortunately). Recently (with Season 2) they were expanded in + use to be used as the "gating" for whether the plug can be inserted at all. For + instance, a Plug might be tracking the number of PVP kills you have made. It + will use the parent item's data about that tracking status to determine what to + show, and will generally show it using the DestinyObjectiveDefinition's + progressDescription property. Refer to the plug's itemHash and objective + property for more information if you would like to display even more data.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemplugdefinition.html b/docs/interfaces/destinyitemplugdefinition.html new file mode 100644 index 0000000..ce524f1 --- /dev/null +++ b/docs/interfaces/destinyitemplugdefinition.html @@ -0,0 +1,536 @@ + + + + + + DestinyItemPlugDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemPlugDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If an item is a Plug, its DestinyInventoryItemDefinition.plug property will be + populated with an instance of one of these bad boys.

        +
        +

        This gives information about when it can be inserted, what the plug's category + is (and thus whether it is compatible with a socket... see + DestinySocketTypeDefinition for information about Plug Categories and socket + compatibility), whether it is enabled and other Plug info.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemPlugDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        alternatePlugStyle

        +
        alternatePlugStyle: PlugUiStyles
        + +
        +
        +

        The alternate plug of the plug: only applies when the item is in states that + only the server can know about and control, unfortunately. See + AlternateUiPlugLabel for the related label info.

        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        + +

        alternateUiPlugLabel

        +
        alternateUiPlugLabel: string
        + +
        +
        +

        If the plug meets certain state requirements, it may have an alternative label + applied to it. This is the alternative label that will be applied in such a + situation.

        +
        +
        +
        +
        + +

        enabledMaterialRequirementHash

        +
        enabledMaterialRequirementHash: number
        + +
        +
        +

        It's not enough for the plug to be inserted. It has to be enabled as well. For + it to be enabled, it may require materials. This is the hash identifier for the + DestinyMaterialRequirementSetDefinition for those requirements, if there is one.

        +
        +

        Mapped to DestinyMaterialRequirementSetDefinition in the manifest.

        +
        +
        +
        + +

        enabledRules

        + + +
        +
        +

        The rules around whether the plug, once inserted, is enabled and providing its + benefits.

        +
        +

        The live data DestinyItemPlugComponent.enableFailIndexes will be an index into + this array, so you can pull out the failure strings appropriate for the user.

        +
        +
        +
        + +

        insertionMaterialRequirementHash

        +
        insertionMaterialRequirementHash: number
        + +
        +
        +

        If inserting this plug requires materials, this is the hash identifier for + looking up the DestinyMaterialRequirementSetDefinition for those requirements.

        +
        +

        Mapped to DestinyMaterialRequirementSetDefinition in the manifest.

        +
        +
        +
        + +

        insertionRules

        +
        insertionRules: DestinyPlugRuleDefinition[]
        + +
        +
        +

        The rules around when this plug can be inserted into a socket, aside from the + socket's individual restrictions.

        +
        +

        The live data DestinyItemPlugComponent.insertFailIndexes will be an index into + this array, so you can pull out the failure strings appropriate for the user.

        +
        +
        +
        + +

        isDummyPlug

        +
        isDummyPlug: boolean
        + +
        +
        +

        If TRUE, this plug is used for UI display purposes only, and doesn't have any + interesting effects of its own.

        +
        +
        +
        +
        + +

        isPseudoPlug

        +
        isPseudoPlug: boolean
        + +
        +
        +

        If TRUE, the plug doesn't actually convey any benefit: it only exists to show + information in the UI.

        +
        +
        +
        +
        + +

        onActionRecreateSelf

        +
        onActionRecreateSelf: boolean
        + +
        +
        +

        If you successfully socket the item, this will determine whether or not you get " + refunded" on the plug.

        +
        +
        +
        +
        + +

        parentItemOverride

        +
        parentItemOverride: DestinyParentItemOverride
        + +
        +
        +

        Do you ever get the feeling that a system has become so overburdened by edge + cases that it probably should have become some other system entirely? So do I!

        +
        +

        In totally unrelated news, Plugs can now override properties of their parent + items. This is some of the relevant definition data for those overrides.

        +

        If this is populated, it will have the override data to be applied when this + plug is applied to an item.

        +
        +
        +
        + +

        plugAvailability

        +
        plugAvailability: PlugAvailabilityMode
        + +
        +
        +

        Indicates the rules about when this plug can be used. See the + PlugAvailabilityMode enumeration for more information!

        +
        +
        +
        +
        + +

        plugCategoryHash

        +
        plugCategoryHash: number
        + +
        +
        +

        The hash for the plugCategoryIdentifier. You can use this instead if you wish: I + put both in the definition for debugging purposes.

        +
        +
        +
        +
        + +

        plugCategoryIdentifier

        +
        plugCategoryIdentifier: string
        + +
        +
        +

        The string identifier for the plug's category. Use the socket's + DestinySocketTypeDefinition.plugWhitelist to determine whether this plug can be + inserted into the socket.

        +
        +
        +
        +
        + +

        plugStyle

        +
        plugStyle: PlugUiStyles
        + +
        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        +
        + +

        previewItemOverrideHash

        +
        previewItemOverrideHash: number
        + +
        +
        +

        In the game, if you're inspecting a plug item directly, this will be the item + shown with the plug attached. Look up the DestinyInventoryItemDefinition for + this hash for the item.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        uiPlugLabel

        +
        uiPlugLabel: string
        + +
        +
        +

        Plugs can have arbitrary, UI-defined identifiers that the UI designers use to + determine the style applied to plugs. Unfortunately, we have neither a + definitive list of these labels nor advance warning of when new labels might be + applied or how that relates to how they get rendered. If you want to, you can + refer to known labels to change your own styles: but know that new ones can be + created arbitrarily, and we have no way of associating the labels with any + specific UI style guidance... you'll have to piece that together on your end. Or + do what we do, and just show plugs more generically, without specialized styles.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitempreviewblockdefinition.html b/docs/interfaces/destinyitempreviewblockdefinition.html new file mode 100644 index 0000000..3021379 --- /dev/null +++ b/docs/interfaces/destinyitempreviewblockdefinition.html @@ -0,0 +1,273 @@ + + + + + + DestinyItemPreviewBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemPreviewBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Items like Sacks or Boxes can have items that it shows in-game when you view + details that represent the items you can obtain if you use or acquire the item.

        +
        +

        This defines those categories, and gives some insights into that data's source.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemPreviewBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        derivedItemCategories

        +
        derivedItemCategories: DestinyDerivedItemCategoryDefinition[]
        + +
        +
        +

        This is a list of the items being previewed, categorized in the same way as they + are in the preview UI.

        +
        +
        +
        +
        + +

        previewActionString

        +
        previewActionString: string
        + +
        +
        +

        If the preview has an associated action (like "Open"), this will be the + localized string for that action.

        +
        +
        +
        +
        + +

        previewVendorHash

        +
        previewVendorHash: number
        + +
        +
        +

        If the preview data is derived from a fake "Preview" Vendor, this will be the + hash identifier for the DestinyVendorDefinition of that fake vendor.

        +
        +

        Mapped to DestinyVendorDefinition in the manifest.

        +
        +
        +
        + +

        screenStyle

        +
        screenStyle: string
        + +
        +
        +

        A string that the game UI uses as a hint for which detail screen to show for the + item. You, too, can leverage this for your own custom screen detail views. Note, + however, that these are arbitrarily defined by designers: there's no guarantees + of a fixed, known number of these - so fall back to something reasonable if you + don't recognize it.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemqualityblockdefinition.html b/docs/interfaces/destinyitemqualityblockdefinition.html new file mode 100644 index 0000000..6e6806c --- /dev/null +++ b/docs/interfaces/destinyitemqualityblockdefinition.html @@ -0,0 +1,325 @@ + + + + + + DestinyItemQualityBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemQualityBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        An item's "Quality" determines its calculated stats. The Level at which the item + spawns is combined with its "qualityLevel" along with some additional + calculations to determine the value of those stats.

        +
        +

        In Destiny 2, most items don't have default item levels and quality, making this + property less useful: these apparently are almost always determined by the + complex mechanisms of the Reward system rather than statically. They are still + provided here in case they are still useful for people. This also contains some + information about Infusion.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemQualityBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        infusionCategoryHash

        +
        infusionCategoryHash: number
        + +
        +
        +

        The hash identifier for the infusion. It does not map to a Definition entity.

        +
        +

        DEPRECATED: Items can now have multiple infusion categories. Please use + infusionCategoryHashes instead.

        +
        +
        +
        + +

        infusionCategoryHashes

        +
        infusionCategoryHashes: number[]
        + +
        +
        +

        If any one of these hashes matches any value in another item's + infusionCategoryHashes, the two can infuse with each other.

        +
        +
        +
        +
        + +

        infusionCategoryName

        +
        infusionCategoryName: string
        + +
        +
        +

        The string identifier for this item's "infusability", if any.

        +
        +

        Items that match the same infusionCategoryName are allowed to infuse with each + other.

        +

        DEPRECATED: Items can now have multiple infusion categories. Please use + infusionCategoryHashes instead.

        +
        +
        +
        + +

        itemLevels

        +
        itemLevels: number[]
        + +
        +
        +

        The "base" defined level of an item. This is a list because, in theory, each + Expansion could define its own base level for an item.

        +
        +

        In practice, not only was that never done in Destiny 1, but now this isn't even + populated at all. When it's not populated, the level at which it spawns has to + be inferred by Reward information, of which BNet receives an imperfect view and + will only be reliable on instanced data as a result.

        +
        +
        +
        + +

        progressionLevelRequirementHash

        +
        progressionLevelRequirementHash: number
        + +
        +
        +

        An item can refer to pre-set level requirements. They are defined in + DestinyProgressionLevelRequirementDefinition, and you can use this hash to find + the appropriate definition.

        +
        +

        Mapped to DestinyProgressionLevelRequirementDefinition in the manifest.

        +
        +
        +
        + +

        qualityLevel

        +
        qualityLevel: number
        + +
        +
        +

        qualityLevel is used in combination with the item's level to calculate stats + like Attack and Defense. It plays a role in that calculation, but not nearly as + large as itemLevel does.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemquantity.html b/docs/interfaces/destinyitemquantity.html new file mode 100644 index 0000000..662bf04 --- /dev/null +++ b/docs/interfaces/destinyitemquantity.html @@ -0,0 +1,251 @@ + + + + + + DestinyItemQuantity | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemQuantity

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Used in a number of Destiny contracts to return data about an item stack and its + quantity. Can optionally return an itemInstanceId if the item is instanced - in + which case, the quantity returned will be 1. If it's not... uh, let me know okay? + Thanks.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemQuantity +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        itemHash

        +
        itemHash: number
        + +
        +
        +

        The hash identifier for the item in question. Use it to look up the item's + DestinyInventoryItemDefinition.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        Optional itemInstanceId

        +
        itemInstanceId: string
        + +
        +
        +

        If this quantity is referring to a specific instance of an item, this will have + the item's instance ID. Normally, this will be null.

        +
        +
        +
        +
        + +

        quantity

        +
        quantity: number
        + +
        +
        +

        The amount of the item needed/available depending on the context of where + DestinyItemQuantity is being used.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemrendercomponent.html b/docs/interfaces/destinyitemrendercomponent.html new file mode 100644 index 0000000..7907e81 --- /dev/null +++ b/docs/interfaces/destinyitemrendercomponent.html @@ -0,0 +1,237 @@ + + + + + + DestinyItemRenderComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemRenderComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Many items can be rendered in 3D. When you request this block, you will obtain + the custom data needed to render this specific instance of the item.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemRenderComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        artRegions

        +
        artRegions: object
        + +
        +
        +

        A dictionary for rendering gear components, with:

        +
        +

        key = Art Arrangement Region Index

        +

        value = The chosen Arrangement Index for the Region, based on the value of a + stat on the item used for making the choice.

        +
        +
        +

        Type declaration

        +
          +
        • +
          [key: number]: number
          +
        • +
        +
        +
        +
        + +

        useCustomDyes

        +
        useCustomDyes: boolean
        + +
        +
        +

        If you should use custom dyes on this item, it will be indicated here.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemresponse.html b/docs/interfaces/destinyitemresponse.html new file mode 100644 index 0000000..c2aae3c --- /dev/null +++ b/docs/interfaces/destinyitemresponse.html @@ -0,0 +1,373 @@ + + + + + + DestinyItemResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemResponse

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The response object for retrieving an individual instanced item. None of these + components are relevant for an item that doesn't have an "itemInstanceId": for + those, get your information from the DestinyInventoryDefinition.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        Optional characterId

        +
        characterId: string
        + +
        +
        +

        If the item is on a character, this will return the ID of the character that is + holding the item.

        +
        +
        +
        +
        + +

        instance

        + + +
        +
        +

        Basic instance data for the item.

        +
        +

        COMPONENT TYPE: ItemInstances

        +
        +
        +
        + +

        item

        + + +
        +
        +

        Common data for the item relevant to its non-instanced properties.

        +
        +

        COMPONENT TYPE: ItemCommonData

        +
        +
        +
        + +

        objectives

        + + +
        +
        +

        Information specifically about the item's objectives.

        +
        +

        COMPONENT TYPE: ItemObjectives

        +
        +
        +
        + +

        perks

        + + +
        +
        +

        Information specifically about the perks currently active on the item.

        +
        +

        COMPONENT TYPE: ItemPerks

        +
        +
        +
        + +

        renderData

        + + +
        +
        +

        Information about how to render the item in 3D.

        +
        +

        COMPONENT TYPE: ItemRenderData

        +
        +
        +
        + +

        sockets

        + + +
        +
        +

        Information about the sockets of the item: which are currently active, what + potential sockets you could have and the stats/abilities/perks you can gain from + them.

        +
        +

        COMPONENT TYPE: ItemSockets

        +
        +
        +
        + +

        stats

        + + +
        +
        +

        Information about the computed stats of the item: power, defense, etc...

        +
        +

        COMPONENT TYPE: ItemStats

        +
        +
        +
        + +

        talentGrid

        + + +
        +
        +

        Information about the talent grid attached to the item. Talent nodes can provide + a variety of benefits and abilities, and in Destiny 2 are used almost + exclusively for the character's "Builds".

        +
        +

        COMPONENT TYPE: ItemTalentGrids

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemsackblockdefinition.html b/docs/interfaces/destinyitemsackblockdefinition.html new file mode 100644 index 0000000..4282d50 --- /dev/null +++ b/docs/interfaces/destinyitemsackblockdefinition.html @@ -0,0 +1,271 @@ + + + + + + DestinyItemSackBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemSackBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Some items are "sacks" - they can be "opened" to produce other items. This is + information related to its sack status, mostly UI strings. Engrams are an + example of items that are considered to be "Sacks".

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemSackBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        detailAction

        +
        detailAction: string
        + +
        +
        +

        A description of what will happen when you open the sack. As far as I can tell, + this is blank currently. Unknown whether it will eventually be populated with + useful info.

        +
        +
        +
        +
        + +

        openAction

        +
        openAction: string
        + +
        +
        +

        The localized name of the action being performed when you open the sack.

        +
        +
        +
        +
        + +

        openOnAcquire

        +
        openOnAcquire: boolean
        + +
        +
        + +

        selectItemCount

        +
        selectItemCount: number
        + +
        +
        + +

        vendorSackType

        +
        vendorSackType: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemsetactionrequest.html b/docs/interfaces/destinyitemsetactionrequest.html new file mode 100644 index 0000000..e4b8021 --- /dev/null +++ b/docs/interfaces/destinyitemsetactionrequest.html @@ -0,0 +1,222 @@ + + + + + + DestinyItemSetActionRequest | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemSetActionRequest

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemSetActionRequest +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        characterId

        +
        characterId: string
        + +
        +
        + +

        itemIds

        +
        itemIds: string[]
        + +
        +
        + +

        membershipType

        +
        membershipType: BungieMembershipType
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemsetblockdefinition.html b/docs/interfaces/destinyitemsetblockdefinition.html new file mode 100644 index 0000000..08fab86 --- /dev/null +++ b/docs/interfaces/destinyitemsetblockdefinition.html @@ -0,0 +1,268 @@ + + + + + + DestinyItemSetBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemSetBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Primarily for Quests, this is the definition of properties related to the item + if it is a quest and its various quest steps.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemSetBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        itemList

        + + +
        +
        +

        A collection of hashes of set items, for items such as Quest Metadata items that + possess this data.

        +
        +
        +
        +
        + +

        requireOrderedSetItemAdd

        +
        requireOrderedSetItemAdd: boolean
        + +
        +
        +

        If true, items in the set can only be added in increasing order, and adding an + item will remove any previous item. For Quests, this is by necessity true. Only + one quest step is present at a time, and previous steps are removed as you + advance in the quest.

        +
        +
        +
        +
        + +

        setIsFeatured

        +
        setIsFeatured: boolean
        + +
        +
        +

        If true, the UI should treat this quest as "featured"

        +
        +
        +
        +
        + +

        setType

        +
        setType: string
        + +
        +
        +

        A string identifier we can use to attempt to identify the category of the Quest.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemsetblockentrydefinition.html b/docs/interfaces/destinyitemsetblockentrydefinition.html new file mode 100644 index 0000000..4541ae7 --- /dev/null +++ b/docs/interfaces/destinyitemsetblockentrydefinition.html @@ -0,0 +1,230 @@ + + + + + + DestinyItemSetBlockEntryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemSetBlockEntryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Defines a particular entry in an ItemSet (AKA a particular Quest Step in a Quest)

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemSetBlockEntryDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        itemHash

        +
        itemHash: number
        + +
        +
        +

        This is the hash identifier for a DestinyInventoryItemDefinition representing + this quest step.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        trackingValue

        +
        trackingValue: number
        + +
        +
        +

        Used for tracking which step a user reached. These values will be populated in + the user's internal state, which we expose externally as a more usable + DestinyQuestStatus object. If this item has been obtained, this value will be + set in trackingUnlockValueHash.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemsocketblockdefinition.html b/docs/interfaces/destinyitemsocketblockdefinition.html new file mode 100644 index 0000000..68d9a59 --- /dev/null +++ b/docs/interfaces/destinyitemsocketblockdefinition.html @@ -0,0 +1,270 @@ + + + + + + DestinyItemSocketBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemSocketBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If defined, the item has at least one socket.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemSocketBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        detail

        +
        detail: string
        + +
        +
        +

        This was supposed to be a string that would give per-item details about sockets. + In practice, it turns out that all this ever has is the localized word "details". + ... that's lame, but perhaps it will become something cool in the future.

        +
        +
        +
        +
        + +

        intrinsicSockets

        + + +
        +
        +

        Each intrinsic (or immutable/permanent) socket on an item is defined here, along + with the plug that is permanently affixed to the socket.

        +
        +
        +
        +
        + +

        socketCategories

        + + +
        +
        +

        A convenience property, that refers to the sockets in the "sockets" property, + pre-grouped by category and ordered in the manner that they should be grouped in + the UI. You could form this yourself with the existing data, but why would you + want to? Enjoy life man.

        +
        +
        +
        +
        + +

        socketEntries

        + + +
        +
        +

        Each non-intrinsic (or mutable) socket on an item is defined here. Check inside + for more info.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemsocketcategorydefinition.html b/docs/interfaces/destinyitemsocketcategorydefinition.html new file mode 100644 index 0000000..742d673 --- /dev/null +++ b/docs/interfaces/destinyitemsocketcategorydefinition.html @@ -0,0 +1,231 @@ + + + + + + DestinyItemSocketCategoryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemSocketCategoryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Sockets are grouped into categories in the UI. These define which category and + which sockets are under that category.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemSocketCategoryDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        socketCategoryHash

        +
        socketCategoryHash: number
        + +
        +
        +

        The hash for the Socket Category: a quick way to go get the header display + information for the category. Use it to look up DestinySocketCategoryDefinition + info.

        +
        +

        Mapped to DestinySocketCategoryDefinition in the manifest.

        +
        +
        +
        + +

        socketIndexes

        +
        socketIndexes: number[]
        + +
        +
        +

        Use these indexes to look up the sockets in the "sockets.socketEntries" property + on the item definition. These are the indexes under the category, in game- + rendered order.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemsocketentrydefinition.html b/docs/interfaces/destinyitemsocketentrydefinition.html new file mode 100644 index 0000000..291b65a --- /dev/null +++ b/docs/interfaces/destinyitemsocketentrydefinition.html @@ -0,0 +1,390 @@ + + + + + + DestinyItemSocketEntryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemSocketEntryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The definition information for a specific socket on an item. This will determine + how the socket behaves in-game.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemSocketEntryDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        defaultVisible

        +
        defaultVisible: boolean
        + +
        +
        +

        If true, then this socket is visible in the item's "default" state. If you have + an instance, you should always check the runtime state, as that can override + this visibility setting: but if you're looking at the item on a conceptual level, + this property can be useful for hiding data such as legacy sockets - which + remain defined on items for infrastructure purposes, but can be confusing for + users to see.

        +
        +
        +
        +
        + +

        hidePerksInItemTooltip

        +
        hidePerksInItemTooltip: boolean
        + +
        +
        +

        If this is true, the perks provided by this socket shouldn't be shown in the + item's tooltip. This might be useful if it's providing a hidden bonus, or if the + bonus is less important than other benefits on the item.

        +
        +
        +
        +
        + +

        plugSources

        +
        plugSources: SocketPlugSources
        + +
        +
        +

        Indicates where you should go to get plugs for this socket. This will affect how + you populate your UI, as well as what plugs are valid for this socket. It's an + alternative to having to check for the existence of certain properties ( + reusablePlugItems for example) to infer where plugs should come from.

        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        + +

        preventInitializationOnVendorPurchase

        +
        preventInitializationOnVendorPurchase: boolean
        + +
        +
        +

        If this is true, then the socket will not be initialized with a plug if the item + is purchased from a Vendor.

        +
        +

        Remember that Vendors are much more than conceptual vendors: they include " + Collection Kiosks" and other entities. See DestinyVendorDefinition for more + information.

        +
        +
        +
        + +

        randomizedPlugItems

        + + +
        +
        +

        As of Forsaken, item sockets can have randomized plugs. If this is populated, + the live data will return a subset of plugs from this list that are active and + able to be inserted into the socket just like a reusable plug.

        +
        +
        +
        +
        + +

        reusablePlugItems

        + + +
        +
        +

        This is a list of pre-determined plugs that can always be plugged into this + socket, without the character having the plug in their inventory.

        +
        +

        If this list is populated, you will not be allowed to plug an arbitrary item in + the socket: you will only be able to choose from one of these reusable plugs.

        +
        +
        +
        + +

        Optional reusablePlugSetHash

        +
        reusablePlugSetHash: number
        + +
        +
        +

        If this socket's plugs come from a reusable DestinyPlugSetDefinition, this is + the identifier for that set. We added this concept to reduce some major + duplication that's going to come from sockets as replacements for what was once + implemented as large sets of items and kiosks (like Emotes).

        +
        +
        +
        +
        + +

        singleInitialItemHash

        +
        singleInitialItemHash: number
        + +
        +
        +

        If a valid hash, this is the hash identifier for the + DestinyInventoryItemDefinition representing the Plug that will be initially + inserted into the item on item creation. Otherwise, this Socket will either + start without a plug inserted, or will have one randomly inserted.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        socketTypeHash

        +
        socketTypeHash: number
        + +
        +
        +

        All sockets have a type, and this is the hash identifier for this particular + type. Use it to look up the DestinySocketTypeDefinition: read there for more + information on how socket types affect the behavior of the socket.

        +
        +

        Mapped to DestinySocketTypeDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemsocketentryplugitemdefinition.html b/docs/interfaces/destinyitemsocketentryplugitemdefinition.html new file mode 100644 index 0000000..7345f3c --- /dev/null +++ b/docs/interfaces/destinyitemsocketentryplugitemdefinition.html @@ -0,0 +1,208 @@ + + + + + + DestinyItemSocketEntryPlugItemDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemSocketEntryPlugItemDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The definition of a known, reusable plug that can be applied to a socket.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemSocketEntryPlugItemDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        plugItemHash

        +
        plugItemHash: number
        + +
        +
        +

        The hash identifier of a DestinyInventoryItemDefinition representing the plug + that can be inserted.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemsocketentryplugitemrandomizeddefinition.html b/docs/interfaces/destinyitemsocketentryplugitemrandomizeddefinition.html new file mode 100644 index 0000000..48143e7 --- /dev/null +++ b/docs/interfaces/destinyitemsocketentryplugitemrandomizeddefinition.html @@ -0,0 +1,201 @@ + + + + + + DestinyItemSocketEntryPlugItemRandomizedDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemSocketEntryPlugItemRandomizedDefinition

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemSocketEntryPlugItemRandomizedDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        plugItemHash

        +
        plugItemHash: number
        + +
        +
        +

        The hash identifier of a DestinyInventoryItemDefinition representing the plug + that can be inserted.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemsocketscomponent.html b/docs/interfaces/destinyitemsocketscomponent.html new file mode 100644 index 0000000..9556355 --- /dev/null +++ b/docs/interfaces/destinyitemsocketscomponent.html @@ -0,0 +1,210 @@ + + + + + + DestinyItemSocketsComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemSocketsComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Instanced items can have sockets, which are slots on the item where plugs can be + inserted.

        +
        +

        Sockets are a bit complex: be sure to examine the documentation on the + DestinyInventoryItemDefinition's "socket" block and elsewhere on these objects + for more details.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemSocketsComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        sockets

        + + +
        +
        +

        The list of all sockets on the item, and their status information.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemsocketstate.html b/docs/interfaces/destinyitemsocketstate.html new file mode 100644 index 0000000..165193f --- /dev/null +++ b/docs/interfaces/destinyitemsocketstate.html @@ -0,0 +1,356 @@ + + + + + + DestinyItemSocketState | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemSocketState

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The status of a given item's socket. (which plug is inserted, if any: whether it + is enabled, what "reusable" plugs can be inserted, etc...)

        +
        +

        If I had it to do over, this would probably have a DestinyItemPlug representing + the inserted item instead of most of these properties. :shrug:

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemSocketState +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        enableFailIndexes

        +
        enableFailIndexes: number[]
        + +
        +
        +

        If a plug is inserted but not enabled, this will be populated with indexes into + the plug item definition's plug.enabledRules property, so that you can show the + reasons why it is not enabled.

        +
        +
        +
        +
        + +

        isEnabled

        +
        isEnabled: boolean
        + +
        +
        +

        Even if a plug is inserted, it doesn't mean it's enabled.

        +
        +

        This flag indicates whether the plug is active and providing its benefits.

        +
        +
        +
        + +

        isVisible

        +
        isVisible: boolean
        + +
        +
        +

        A plug may theoretically provide benefits but not be visible - for instance, + some older items use a plug's damage type perk to modify their own damage type. + These, though they are not visible, still affect the item. This field indicates + that state.

        +
        +

        An invisible plug, while it provides benefits if it is Enabled, cannot be + directly modified by the user.

        +
        +
        +
        + +

        Optional plugHash

        +
        plugHash: number
        + +
        +
        +

        The currently active plug, if any.

        +
        +

        Note that, because all plugs are statically defined, its effect on stats and + perks can be statically determined using the plug item's definition. The stats + and perks can be taken at face value on the plug item as the stats and perks it + will provide to the user/item.

        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        plugObjectives

        +
        plugObjectives: DestinyObjectiveProgress[]
        + +
        +
        +

        Sometimes, Plugs may have objectives: generally, these are used for flavor and + display purposes. For instance, a Plug might be tracking the number of PVP kills + you have made. It will use the parent item's data about that tracking status to + determine what to show, and will generally show it using the + DestinyObjectiveDefinition's progressDescription property. Refer to the plug's + itemHash and objective property for more information if you would like to + display even more data.

        +
        +
        +
        +
        + +

        reusablePlugHashes

        +
        reusablePlugHashes: number[]
        + +
        +
        +

        If the item supports reusable plugs, this is the list of plug item hashes that + are currently allowed to be used for this socket. See the "reusablePlugs" + property, which has rendered this obsolete, for more information.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        reusablePlugs

        +
        reusablePlugs: DestinyItemPlug[]
        + +
        +
        +

        If the item supports reusable plugs, this is the list of plugs that are allowed + to be used for the socket, and any relevant information about whether they are " + enabled", whether they are allowed to be inserted, and any other information + such as objectives.

        +
        +

        A Reusable Plug is a plug that you can always insert into this socket as long as + its insertion rules are passed, regardless of whether or not you have the plug + in your inventory. An example of it failing an insertion rule would be if it has + an Objective that needs to be completed before it can be inserted, and that + objective hasn't been completed yet.

        +

        In practice, a socket will either have reusable plugs or it will allow for + plugs in your inventory to be inserted. See DestinyInventoryItemDefinition. + socket for more info.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemsourceblockdefinition.html b/docs/interfaces/destinyitemsourceblockdefinition.html new file mode 100644 index 0000000..eca2206 --- /dev/null +++ b/docs/interfaces/destinyitemsourceblockdefinition.html @@ -0,0 +1,267 @@ + + + + + + DestinyItemSourceBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemSourceBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Data about an item's "sources": ways that the item can be obtained.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemSourceBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        exclusive

        + + +
        +
        +

        If we found that this item is exclusive to a specific platform, this will be set + to the BungieMembershipType enumeration that matches that platform.

        +
        +
        +
        +
        + +

        sourceHashes

        +
        sourceHashes: number[]
        + +
        +
        +

        The list of hash identifiers for Reward Sources that hint where the item can be + found (DestinyRewardSourceDefinition).

        +
        +

        Mapped to DestinyRewardSourceDefinition in the manifest.

        +
        +
        +
        + +

        sources

        + + +
        +
        +

        A collection of details about the stats that were computed for the ways we found + that the item could be spawned.

        +
        +
        +
        +
        + +

        vendorSources

        + + +
        +
        +

        A denormalized reference back to vendors that potentially sell this item.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemsourcedefinition.html b/docs/interfaces/destinyitemsourcedefinition.html new file mode 100644 index 0000000..4f915e4 --- /dev/null +++ b/docs/interfaces/destinyitemsourcedefinition.html @@ -0,0 +1,342 @@ + + + + + + DestinyItemSourceDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemSourceDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Properties of a DestinyInventoryItemDefinition that store all of the information + we were able to discern about how the item spawns, and where you can find the + item.

        +
        +

        Items will have many of these sources, one per level at which it spawns, to try + and give more granular data about where items spawn for specific level ranges.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemSourceDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        computedStats

        +
        computedStats: object
        + +
        +
        +

        The stats computed for this level/quality range.

        +
        +
        +
        +

        Type declaration

        + +
        +
        +
        + +

        level

        +
        level: number
        + +
        +
        +

        The level at which the item spawns. Essentially the Primary Key for this source + data: there will be multiple of these source entries per item that has source + data, grouped by the level at which the item spawns.

        +
        +
        +
        +
        + +

        maxLevelRequired

        +
        maxLevelRequired: number
        + +
        +
        +

        The maximum Character Level required for equipping the item when the item spawns + at the item level defined on this DestinyItemSourceDefinition, as far as we saw + in our processing.

        +
        +
        +
        +
        + +

        maxQuality

        +
        maxQuality: number
        + +
        +
        +

        The maximum quality at which the item spawns for this level.

        +
        +
        +
        +
        + +

        minLevelRequired

        +
        minLevelRequired: number
        + +
        +
        +

        The minimum Character Level required for equipping the item when the item spawns + at the item level defined on this DestinyItemSourceDefinition, as far as we saw + in our processing.

        +
        +
        +
        +
        + +

        minQuality

        +
        minQuality: number
        + +
        +
        +

        The minimum Quality at which the item spawns for this level. Examine + DestinyInventoryItemDefinition for more information about what Quality means. + Just don't ask Phaedrus about it, he'll never stop talking and you'll have to + write a book about it.

        +
        +
        +
        +
        + +

        sourceHashes

        +
        sourceHashes: number[]
        + +
        +
        +

        The DestinyRewardSourceDefinitions found that can spawn the item at this level.

        +
        +

        Mapped to DestinyRewardSourceDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemstatblockdefinition.html b/docs/interfaces/destinyitemstatblockdefinition.html new file mode 100644 index 0000000..e91d919 --- /dev/null +++ b/docs/interfaces/destinyitemstatblockdefinition.html @@ -0,0 +1,328 @@ + + + + + + DestinyItemStatBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemStatBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Information about the item's calculated stats, with as much data as we can find + for the stats without having an actual instance of the item.

        +
        +

        Note that this means the entire concept of providing these stats is + fundamentally insufficient: we cannot predict with 100% accuracy the conditions + under which an item can spawn, so we use various heuristics to attempt to + simulate the conditions as accurately as possible. Actual stats for items in- + game can and will vary, but these should at least be useful base points for + comparison and display.

        +

        It is also worth noting that some stats, like Magazine size, have further + calculations performed on them by scripts in-game and on the game servers that + BNet does not have access to. We cannot know how those stats are further + transformed, and thus some stats will be inaccurate even on instances of items + in BNet vs. how they appear in-game. This is a known limitation of our item + statistics, without any planned fix.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemStatBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        disablePrimaryStatDisplay

        +
        disablePrimaryStatDisplay: boolean
        + +
        +
        +

        If true, the game won't show the "primary" stat on this item when you inspect it.

        +
        +

        NOTE: This is being manually mapped, because I happen to want it in a block that + isn't going to directly create this derivative block.

        +
        +
        +
        + +

        hasDisplayableStats

        +
        hasDisplayableStats: boolean
        + +
        +
        +

        A quick and lazy way to determine whether any stat other than the "primary" stat + is actually visible on the item. Items often have stats that we return in case + people find them useful, but they're not part of the "Stat Group" and thus we + wouldn't display them in our UI. If this is False, then we're not going to + display any of these stats other than the primary one.

        +
        +
        +
        +
        + +

        primaryBaseStatHash

        +
        primaryBaseStatHash: number
        + +
        +
        +

        This stat is determined to be the "primary" stat, and can be looked up in the + stats or any other stat collection related to the item.

        +
        +

        Use this hash to look up the stat's value using DestinyInventoryItemDefinition. + stats.stats, and the renderable data for the primary stat in the related + DestinyStatDefinition.

        +

        Mapped to DestinyStatDefinition in the manifest.

        +
        +
        +
        + +

        Optional statGroupHash

        +
        statGroupHash: number
        + +
        +
        +

        If the item's stats are meant to be modified by a DestinyStatGroupDefinition, + this will be the identifier for that definition.

        +
        +

        If you are using live data or precomputed stats data on the + DestinyInventoryItemDefinition.stats.stats property, you don't have to worry + about statGroupHash and how it alters stats: the already altered stats are + provided to you. But if you want to see how the sausage gets made, or perform + computations yourself, this is valuable information.

        +

        Mapped to DestinyStatGroupDefinition in the manifest.

        +
        +
        +
        + +

        stats

        +
        stats: object
        + +
        +
        +

        If you are looking for precomputed values for the stats on a weapon, this is + where they are stored. Technically these are the "Display" stat values. Please + see DestinyStatsDefinition for what Display Stat Values means, it's a very long + story... but essentially these are the closest values BNet can get to the item + stats that you see in-game.

        +
        +

        These stats are keyed by the DestinyStatDefinition's hash identifier for the + stat that's found on the item.

        +

        Mapped to DestinyStatDefinition in the manifest.

        +
        +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemstaterequest.html b/docs/interfaces/destinyitemstaterequest.html new file mode 100644 index 0000000..1e38e3f --- /dev/null +++ b/docs/interfaces/destinyitemstaterequest.html @@ -0,0 +1,236 @@ + + + + + + DestinyItemStateRequest | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemStateRequest

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemStateRequest +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        characterId

        +
        characterId: string
        + +
        +
        + +

        itemId

        +
        itemId: string
        + +
        +
        + +

        membershipType

        +
        membershipType: BungieMembershipType
        + +
        +
        + +

        state

        +
        state: boolean
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemstatscomponent.html b/docs/interfaces/destinyitemstatscomponent.html new file mode 100644 index 0000000..81b4b35 --- /dev/null +++ b/docs/interfaces/destinyitemstatscomponent.html @@ -0,0 +1,220 @@ + + + + + + DestinyItemStatsComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemStatsComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If you want the stats on an item's instanced data, get this component.

        +
        +

        These are stats like Attack, Defense etc... and not historical stats.

        +

        Note that some stats have additional computation in-game at runtime - for + instance, Magazine Size - and thus these stats might not be 100% accurate + compared to what you see in-game for some stats. I know, it sucks. I hate it too.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemStatsComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        stats

        +
        stats: object
        + +
        +
        +

        If the item has stats that it provides (damage, defense, etc...), it will be + given here.

        +
        +

        Mapped to DestinyStatDefinition in the manifest.

        +
        +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemsummaryblockdefinition.html b/docs/interfaces/destinyitemsummaryblockdefinition.html new file mode 100644 index 0000000..24f4515 --- /dev/null +++ b/docs/interfaces/destinyitemsummaryblockdefinition.html @@ -0,0 +1,208 @@ + + + + + + DestinyItemSummaryBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemSummaryBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This appears to be information used when rendering rewards. We don't currently + use it on BNet.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemSummaryBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        sortPriority

        +
        sortPriority: number
        + +
        +
        +

        Apparently when rendering an item in a reward, this should be used as a sort + priority. We're not doing it presently.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemtalentgridblockdefinition.html b/docs/interfaces/destinyitemtalentgridblockdefinition.html new file mode 100644 index 0000000..5e5572a --- /dev/null +++ b/docs/interfaces/destinyitemtalentgridblockdefinition.html @@ -0,0 +1,295 @@ + + + + + + DestinyItemTalentGridBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemTalentGridBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This defines information that can only come from a talent grid on an item. Items + mostly have negligible talent grid data these days, but instanced items still + retain grids as a source for some of this common information.

        +
        +

        Builds/Subclasses are the only items left that still have talent grids with + meaningful Nodes.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemTalentGridBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        buildName

        +
        buildName: string
        + +
        +
        +

        A shortcut string identifier for the "build" in question, if this talent grid + has an associated build. Doesn't map to anything we can expose at the moment.

        +
        +
        +
        +
        + +

        hudDamageType

        +
        hudDamageType: DamageType
        + +
        +
        +

        If the talent grid implies a damage type, this is the enum value for that damage + type.

        +
        +
        +
        +
        + +

        hudIcon

        +
        hudIcon: string
        + +
        +
        +

        If the talent grid has a special icon that's shown in the game UI (like builds, + funny that), this is the identifier for that icon. Sadly, we don't actually get + that icon right now. I'll be looking to replace this with a path to the actual + icon itself.

        +
        +
        +
        +
        + +

        itemDetailString

        +
        itemDetailString: string
        + +
        +
        +

        This is meant to be a subtitle for looking at the talent grid. In practice, + somewhat frustratingly, this always merely says the localized word for "Details". + Great. Maybe it'll have more if talent grids ever get used for more than builds + and subclasses again.

        +
        +
        +
        +
        + +

        talentGridHash

        +
        talentGridHash: number
        + +
        +
        +

        The hash identifier of the DestinyTalentGridDefinition attached to this item.

        +
        +

        Mapped to DestinyTalentGridDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemtalentgridcomponent.html b/docs/interfaces/destinyitemtalentgridcomponent.html new file mode 100644 index 0000000..6581e0a --- /dev/null +++ b/docs/interfaces/destinyitemtalentgridcomponent.html @@ -0,0 +1,289 @@ + + + + + + DestinyItemTalentGridComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemTalentGridComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Well, we're here in Destiny 2, and Talent Grids are unfortunately still around.

        +
        +

        The good news is that they're pretty much only being used for certain base + information on items and for Builds/Subclasses. The bad news is that they still + suck. If you really want this information, grab this component.

        +

        An important note is that talent grids are defined as such:

        +

        A Grid has 1:M Nodes, which has 1:M Steps.

        +

        Any given node can only have a single step active at one time, which represents + the actual visual contents and effects of the Node (for instance, if you see a " + Super Cool Bonus" node, the actual icon and text for the node is coming from the + current Step of that node).

        +

        Nodes can be grouped into exclusivity sets and as of D2, exclusivity groups ( + which are collections of exclusivity sets that affect each other).

        +

        See DestinyTalentGridDefinition for more information. Brace yourself, the water' + s cold out there in the deep end.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemTalentGridComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        gridProgression

        +
        gridProgression: DestinyProgression
        + +
        +
        +

        If the item has a progression, it will be detailed here. A progression means + that the item can gain experience. Thresholds of experience are what determines + whether and when a talent node can be activated.

        +
        +
        +
        +
        + +

        isGridComplete

        +
        isGridComplete: boolean
        + +
        +
        +

        Indicates whether the talent grid on this item is completed, and thus whether it + should have a gold border around it.

        +
        +

        Only will be true if the item actually has a talent grid, and only then if it + is completed (i.e. every exclusive set has an activated node, and every non- + exclusive set node has been activated)

        +
        +
        +
        + +

        nodes

        + + +
        +
        +

        Detailed information about the individual nodes in the talent grid.

        +
        +

        A node represents a single visual "pip" in the talent grid or Build detail view, + though each node may have multiple "steps" which indicate the actual bonuses and + visual representation of that node.

        +
        +
        +
        + +

        talentGridHash

        +
        talentGridHash: number
        + +
        +
        +

        Most items don't have useful talent grids anymore, but Builds in particular + still do.

        +
        +

        You can use this hash to lookup the DestinyTalentGridDefinition attached to this + item, which will be crucial for understanding the node values on the item.

        +

        Mapped to DestinyTalentGridDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemtiertypedefinition.html b/docs/interfaces/destinyitemtiertypedefinition.html new file mode 100644 index 0000000..fda5413 --- /dev/null +++ b/docs/interfaces/destinyitemtiertypedefinition.html @@ -0,0 +1,283 @@ + + + + + + DestinyItemTierTypeDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemTierTypeDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Defines the tier type of an item. Mostly this provides human readable properties + for types like Common, Rare, etc...

        +
        +

        It also provides some base data for infusion that could be useful.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemTierTypeDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        infusionProcess

        + + +
        +
        +

        If this tier defines infusion properties, they will be contained here.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemtiertypeinfusionblock.html b/docs/interfaces/destinyitemtiertypeinfusionblock.html new file mode 100644 index 0000000..ceb1f0f --- /dev/null +++ b/docs/interfaces/destinyitemtiertypeinfusionblock.html @@ -0,0 +1,225 @@ + + + + + + DestinyItemTierTypeInfusionBlock | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemTierTypeInfusionBlock

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemTierTypeInfusionBlock +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        baseQualityTransferRatio

        +
        baseQualityTransferRatio: number
        + +
        +
        +

        The default portion of quality that will transfer from the infuser to the + infusee item. (InfuserQuality - InfuseeQuality) * baseQualityTransferRatio = + base quality transferred.

        +
        +
        +
        +
        + +

        minimumQualityIncrement

        +
        minimumQualityIncrement: number
        + +
        +
        +

        As long as InfuserQuality > InfuseeQuality, the amount of quality bestowed is + guaranteed to be at least this value, even if the transferRatio would dictate + that it should be less. The total amount of quality that ends up in the Infusee + cannot exceed the Infuser's quality however (for instance, if you infuse a 300 + item with a 301 item and the minimum quality increment is 10, the infused item + will not end up with 310 quality)

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemtransferrequest.html b/docs/interfaces/destinyitemtransferrequest.html new file mode 100644 index 0000000..40dbf1e --- /dev/null +++ b/docs/interfaces/destinyitemtransferrequest.html @@ -0,0 +1,264 @@ + + + + + + DestinyItemTransferRequest | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemTransferRequest

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemTransferRequest +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        characterId

        +
        characterId: string
        + +
        +
        + +

        itemId

        +
        itemId: string
        + +
        +
        + +

        itemReferenceHash

        +
        itemReferenceHash: number
        + +
        +
        + +

        membershipType

        +
        membershipType: BungieMembershipType
        + +
        +
        + +

        stackSize

        +
        stackSize: number
        + +
        +
        + +

        transferToVault

        +
        transferToVault: boolean
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemtranslationblockdefinition.html b/docs/interfaces/destinyitemtranslationblockdefinition.html new file mode 100644 index 0000000..8de0596 --- /dev/null +++ b/docs/interfaces/destinyitemtranslationblockdefinition.html @@ -0,0 +1,285 @@ + + + + + + DestinyItemTranslationBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemTranslationBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This Block defines the rendering data associated with the item, if any.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemTranslationBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        arrangements

        + + +
        +
        + +

        customDyes

        +
        customDyes: DyeReference[]
        + +
        +
        + +

        defaultDyes

        +
        defaultDyes: DyeReference[]
        + +
        +
        + +

        hasGeometry

        +
        hasGeometry: boolean
        + +
        +
        + +

        lockedDyes

        +
        lockedDyes: DyeReference[]
        + +
        +
        + +

        weaponPatternHash

        +
        weaponPatternHash: number
        + +
        +
        + +

        weaponPatternIdentifier

        +
        weaponPatternIdentifier: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemvalueblockdefinition.html b/docs/interfaces/destinyitemvalueblockdefinition.html new file mode 100644 index 0000000..a74eff9 --- /dev/null +++ b/docs/interfaces/destinyitemvalueblockdefinition.html @@ -0,0 +1,235 @@ + + + + + + DestinyItemValueBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemValueBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This defines an item's "Value". Unfortunately, this appears to be used in + different ways depending on the way that the item itself is used.

        +
        +

        For items being sold at a Vendor, this is the default "sale price" of the item. + These days, the vendor itself almost always sets the price, but it still + possible for the price to fall back to this value. For quests, it is a preview + of rewards you can gain by completing the quest. For dummy items, if the + itemValue refers to an Emblem, it is the emblem that should be shown as the + reward. (jeez louise)

        +

        It will likely be used in a number of other ways in the future, it appears to be + a bucket where they put arbitrary items and quantities into the item.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemValueBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        itemValue

        +
        itemValue: DestinyItemQuantity[]
        + +
        +
        +

        References to the items that make up this item's "value", and the quantity.

        +
        +
        +
        +
        + +

        valueDescription

        +
        valueDescription: string
        + +
        +
        +

        If there's a localized text description of the value provided, this will be said + description.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyitemvendorsourcereference.html b/docs/interfaces/destinyitemvendorsourcereference.html new file mode 100644 index 0000000..660522f --- /dev/null +++ b/docs/interfaces/destinyitemvendorsourcereference.html @@ -0,0 +1,236 @@ + + + + + + DestinyItemVendorSourceReference | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyItemVendorSourceReference

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents that a vendor could sell this item, and provides a quick link to that + vendor and sale item.

        +
        +

        Note that we do not and cannot make a guarantee that the vendor will ever * + actually* sell this item, only that the Vendor has a definition that indicates + it could be sold.

        +

        Note also that a vendor may sell the same item in multiple "ways", which means + there may be multiple vendorItemIndexes for a single Vendor hash.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyItemVendorSourceReference +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        vendorHash

        +
        vendorHash: number
        + +
        +
        +

        The identifier for the vendor that may sell this item.

        +
        +

        Mapped to DestinyVendorDefinition in the manifest.

        +
        +
        +
        + +

        vendorItemIndexes

        +
        vendorItemIndexes: number[]
        + +
        +
        +

        The Vendor sale item indexes that represent the sale information for this item. + The same vendor may sell an item in multiple "ways", hence why this is a list. ( + for instance, a weapon may be "sold" as a reward in a quest, for Glimmer, and + for Masterwork Cores: each of those ways would be represented by a different + vendor sale item with a different index)

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinykioskitem.html b/docs/interfaces/destinykioskitem.html new file mode 100644 index 0000000..011f991 --- /dev/null +++ b/docs/interfaces/destinykioskitem.html @@ -0,0 +1,262 @@ + + + + + + DestinyKioskItem | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyKioskItem

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyKioskItem +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        canAcquire

        +
        canAcquire: boolean
        + +
        +
        +

        If true, the user can not only see the item, but they can acquire it. It is + possible that a user can see a kiosk item and not be able to acquire it.

        +
        +
        +
        +
        + +

        failureIndexes

        +
        failureIndexes: number[]
        + +
        +
        +

        Indexes into failureStrings for the Vendor, indicating the reasons why it failed + if any.

        +
        +
        +
        +
        + +

        flavorObjective

        +
        flavorObjective: DestinyObjectiveProgress
        + +
        +
        +

        I may regret naming it this way - but this represents when an item has an + objective that doesn't serve a beneficial purpose, but rather is used for " + flavor" or additional information. For instance, when Emblems track specific + stats, those stats are represented as Objectives on the item.

        +
        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the item in the related DestinyVendorDefintion's itemList property, + representing the sale.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinykioskscomponent.html b/docs/interfaces/destinykioskscomponent.html new file mode 100644 index 0000000..7aed872 --- /dev/null +++ b/docs/interfaces/destinykioskscomponent.html @@ -0,0 +1,227 @@ + + + + + + DestinyKiosksComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyKiosksComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A Kiosk is a Vendor (DestinyVendorDefinition) that sells items based on whether + you have already acquired that item before.

        +
        +

        This component returns information about what Kiosk items are available to you + on a Profile level. It is theoretically possible for Kiosks to have items + gated by specific Character as well. If you ever have those, you will find them + on the individual character's DestinyCharacterKiosksComponent.

        +

        Note that, because this component returns vendorItemIndexes (that is to say, + indexes into the Kiosk Vendor's itemList property), these results are + necessarily content version dependent. Make sure that you have the latest + version of the content manifest databases before using this data.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyKiosksComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        kioskItems

        +
        kioskItems: object
        + +
        +
        +

        A dictionary keyed by the Kiosk Vendor's hash identifier (use it to look up the + DestinyVendorDefinition for the relevant kiosk vendor), and whose value is a + list of all the items that the user can "see" in the Kiosk, and any other + interesting metadata.

        +
        +

        Mapped to DestinyVendorDefinition in the manifest.

        +
        +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyleaderboard.html b/docs/interfaces/destinyleaderboard.html new file mode 100644 index 0000000..ea38305 --- /dev/null +++ b/docs/interfaces/destinyleaderboard.html @@ -0,0 +1,208 @@ + + + + + + DestinyLeaderboard | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyLeaderboard

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyLeaderboard +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        entries

        + + +
        +
        + +

        statId

        +
        statId: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyleaderboardentry.html b/docs/interfaces/destinyleaderboardentry.html new file mode 100644 index 0000000..0a0a081 --- /dev/null +++ b/docs/interfaces/destinyleaderboardentry.html @@ -0,0 +1,256 @@ + + + + + + DestinyLeaderboardEntry | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyLeaderboardEntry

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyLeaderboardEntry +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        characterId

        +
        characterId: string
        + +
        +
        +

        ID of the player's best character for the reported stat.

        +
        +
        +
        +
        + +

        player

        + + +
        +
        +

        Identity details of the player

        +
        +
        +
        +
        + +

        rank

        +
        rank: number
        + +
        +
        +

        Where this player ranks on the leaderboard. A value of 1 is the top rank.

        +
        +
        +
        +
        + +

        value

        + + +
        +
        +

        Value of the stat for this player

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinylinkedgraphdefinition.html b/docs/interfaces/destinylinkedgraphdefinition.html new file mode 100644 index 0000000..b16fe46 --- /dev/null +++ b/docs/interfaces/destinylinkedgraphdefinition.html @@ -0,0 +1,272 @@ + + + + + + DestinyLinkedGraphDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyLinkedGraphDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This describes links between the current graph and others, as well as when that + link is relevant.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyLinkedGraphDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        description

        +
        description: string
        + +
        +
        + +

        linkedGraphId

        +
        linkedGraphId: number
        + +
        +
        + +

        linkedGraphs

        + + +
        +
        + +

        name

        +
        name: string
        + +
        +
        + +

        overview

        +
        overview: string
        + +
        +
        + +

        unlockExpression

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinylinkedgraphentrydefinition.html b/docs/interfaces/destinylinkedgraphentrydefinition.html new file mode 100644 index 0000000..eaeb472 --- /dev/null +++ b/docs/interfaces/destinylinkedgraphentrydefinition.html @@ -0,0 +1,194 @@ + + + + + + DestinyLinkedGraphEntryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyLinkedGraphEntryDefinition

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyLinkedGraphEntryDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activityGraphHash

        +
        activityGraphHash: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinylinkedprofilesresponse.html b/docs/interfaces/destinylinkedprofilesresponse.html new file mode 100644 index 0000000..f34ed44 --- /dev/null +++ b/docs/interfaces/destinylinkedprofilesresponse.html @@ -0,0 +1,256 @@ + + + + + + DestinyLinkedProfilesResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyLinkedProfilesResponse

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        I know what you seek. You seek linked accounts. Found them, you have.

        +
        +

        This contract returns a minimal amount of data about Destiny Accounts that are + linked through your Bungie.Net account. We will not return accounts in this + response whose

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyLinkedProfilesResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        bnetMembership

        +
        bnetMembership: UserInfoCard
        + +
        +
        +

        If the requested membership had a linked Bungie.Net membership ID, this is the + basic information about that BNet account.

        +
        +

        I know, Tetron; I know this is mixing UserServices concerns with DestinyServices + concerns. But it's so damn convenient! https://www.youtube.com/watch?v=X5R-bB- + gKVI

        +
        +
        +
        + +

        profiles

        + + +
        +
        +

        Any Destiny account for whom we could successfully pull characters will be + returned here, as the Platform-level summary of user data. (no character data, + no Destiny account data other than the Membership ID and Type so you can make + further queries)

        +
        +
        +
        +
        + +

        profilesWithErrors

        +
        profilesWithErrors: DestinyErrorProfile[]
        + +
        +
        +

        This is brief summary info for profiles that we believe have valid Destiny info, + but who failed to return data for some other reason and thus we know that + subsequent calls for their info will also fail.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinylocationdefinition.html b/docs/interfaces/destinylocationdefinition.html new file mode 100644 index 0000000..81f5fde --- /dev/null +++ b/docs/interfaces/destinylocationdefinition.html @@ -0,0 +1,294 @@ + + + + + + DestinyLocationDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyLocationDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A "Location" is a sort of shortcut for referring to a specific combination of + Activity, Destination, Place, and even Bubble or NavPoint within a space.

        +
        +

        Most of this data isn't intrinsically useful to us, but Objectives refer to + locations, and through that we can at least infer the Activity, Destination, and + Place being referred to by the Objective.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyLocationDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        locationReleases

        + + +
        +
        +

        A Location may refer to different specific spots in the world based on the world' + s current state. This is a list of those potential spots, and the data we can + use at runtime to determine which one of the spots is the currently valid one.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        vendorHash

        +
        vendorHash: number
        + +
        +
        +

        If the location has a Vendor on it, this is the hash identifier for that Vendor. + Look them up with DestinyVendorDefinition.

        +
        +

        Mapped to DestinyVendorDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinylocationreleasedefinition.html b/docs/interfaces/destinylocationreleasedefinition.html new file mode 100644 index 0000000..a050145 --- /dev/null +++ b/docs/interfaces/destinylocationreleasedefinition.html @@ -0,0 +1,449 @@ + + + + + + DestinyLocationReleaseDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyLocationReleaseDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A specific "spot" referred to by a location. Only one of these can be active at + a time for a given Location.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyLocationReleaseDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activityBubbleName

        +
        activityBubbleName: number
        + +
        +
        +

        The Activity Bubble within the Destination. Look this up in the + DestinyDestinationDefinition's bubbles and bubbleSettings properties.

        +
        +
        +
        +
        + +

        activityGraphHash

        +
        activityGraphHash: number
        + +
        +
        +

        The Activity Graph being pointed to by this location.

        +
        +
        +
        +
        + +

        activityGraphNodeHash

        +
        activityGraphNodeHash: number
        + +
        +
        +

        The Activity Graph Node being pointed to by this location. (Remember that + Activity Graph Node hashes are only unique within an Activity Graph: so use the + combination to find the node being spoken of)

        +
        +
        +
        +
        + +

        activityHash

        +
        activityHash: number
        + +
        +
        +

        The Activity being pointed to by this location.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        activityPathBundle

        +
        activityPathBundle: number
        + +
        +
        +

        If we had map information, this would tell us something cool about the path this + location wants you to take. I wish we had map information.

        +
        +
        +
        +
        + +

        activityPathDestination

        +
        activityPathDestination: number
        + +
        +
        +

        If we had map information, this would tell us about path information related to + destination on the map. Sad. Maybe you can do something cool with it. Go to town + man.

        +
        +
        +
        +
        + +

        destinationHash

        +
        destinationHash: number
        + +
        +
        +

        The Destination being pointed to by this location.

        +
        +

        Mapped to DestinyDestinationDefinition in the manifest.

        +
        +
        +
        + +

        displayProperties

        + + +
        +
        +

        Sadly, these don't appear to be populated anymore (ever?)

        +
        +
        +
        +
        + +

        largeTransparentIcon

        +
        largeTransparentIcon: string
        + +
        +
        + +

        mapIcon

        +
        mapIcon: string
        + +
        +
        + +

        navPointType

        + + +
        +
        +

        The type of Nav Point that this represents. See the enumeration for more info.

        +
        +
        +
        +
        + +

        smallTransparentIcon

        +
        smallTransparentIcon: string
        + +
        +
        + +

        spawnPoint

        +
        spawnPoint: number
        + +
        +
        +

        If we had map information, this spawnPoint would be interesting. But sadly, we + don't have that info.

        +
        +
        +
        +
        + +

        worldPosition

        +
        worldPosition: number[]
        + +
        +
        +

        Looks like it should be the position on the map, but sadly it does not look + populated... yet?

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyloredefinition.html b/docs/interfaces/destinyloredefinition.html new file mode 100644 index 0000000..a099f56 --- /dev/null +++ b/docs/interfaces/destinyloredefinition.html @@ -0,0 +1,280 @@ + + + + + + DestinyLoreDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyLoreDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        These are definitions for in-game "Lore," meant to be narrative enhancements of + the game experience.

        +
        +

        DestinyInventoryItemDefinitions for interesting items point to these definitions, + but nothing's stopping you from scraping all of these and doing something cool + with them. If they end up having cool data.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyLoreDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        subtitle

        +
        subtitle: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymanifest.html b/docs/interfaces/destinymanifest.html new file mode 100644 index 0000000..4fb934b --- /dev/null +++ b/docs/interfaces/destinymanifest.html @@ -0,0 +1,334 @@ + + + + + + DestinyManifest | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyManifest

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        DestinyManifest is the external-facing contract for just the properties needed + by those calling the Destiny Platform.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyManifest +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        iconImagePyramidInfo

        +
        iconImagePyramidInfo: ImagePyramidEntry[]
        + +
        +
        +

        Information about the "Image Pyramid" for Destiny icons. Where possible, we + create smaller versions of Destiny icons. These are found as subfolders under + the location of the "original/full size" Destiny images, with the same file name + and extension as the original image itself. (this lets us avoid sending largely + redundant path info with every entity, at the expense of the smaller versions of + the image being less discoverable)

        +
        +
        +
        +
        + +

        jsonWorldContentPaths

        +
        jsonWorldContentPaths: object
        + +
        +

        Type declaration

        +
          +
        • +
          [key: string]: string
          +
        • +
        +
        +
        +
        + +

        mobileAssetContentPath

        +
        mobileAssetContentPath: string
        + +
        +
        + +

        mobileClanBannerDatabasePath

        +
        mobileClanBannerDatabasePath: string
        + +
        +
        + +

        mobileGearAssetDataBases

        +
        mobileGearAssetDataBases: GearAssetDataBaseDefinition[]
        + +
        +
        + +

        mobileGearCDN

        +
        mobileGearCDN: object
        + +
        +

        Type declaration

        +
          +
        • +
          [key: string]: string
          +
        • +
        +
        +
        +
        + +

        mobileWorldContentPaths

        +
        mobileWorldContentPaths: object
        + +
        +

        Type declaration

        +
          +
        • +
          [key: string]: string
          +
        • +
        +
        +
        +
        + +

        version

        +
        version: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymaterialrequirement.html b/docs/interfaces/destinymaterialrequirement.html new file mode 100644 index 0000000..4b6e926 --- /dev/null +++ b/docs/interfaces/destinymaterialrequirement.html @@ -0,0 +1,274 @@ + + + + + + DestinyMaterialRequirement | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMaterialRequirement

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Many actions relating to items require you to expend materials: - Activating a + talent node - Inserting a plug into a socket The items will refer to material + requirements by a materialRequirementsHash in these cases, and this is the + definition for those requirements in terms of the item required, how much of it + is required and other interesting info. This is one of the rare/strange times + where a single contract class is used both in definitions and in live data + response contracts. I'm not sure yet whether I regret that.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMaterialRequirement +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        count

        +
        count: number
        + +
        +
        +

        The amount of the material required.

        +
        +
        +
        +
        + +

        deleteOnAction

        +
        deleteOnAction: boolean
        + +
        +
        +

        If True, the material will be removed from the character's inventory when the + action is performed.

        +
        +
        +
        +
        + +

        itemHash

        +
        itemHash: number
        + +
        +
        +

        The hash identifier of the material required. Use it to look up the material's + DestinyInventoryItemDefinition.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        omitFromRequirements

        +
        omitFromRequirements: boolean
        + +
        +
        +

        If True, this requirement is "silent": don't bother showing it in a material + requirements display. I mean, I'm not your mom: I'm not going to tell you you * + can't* show it. But we won't show it in our UI.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymaterialrequirementsetdefinition.html b/docs/interfaces/destinymaterialrequirementsetdefinition.html new file mode 100644 index 0000000..803236e --- /dev/null +++ b/docs/interfaces/destinymaterialrequirementsetdefinition.html @@ -0,0 +1,270 @@ + + + + + + DestinyMaterialRequirementSetDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMaterialRequirementSetDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represent a set of material requirements: Items that either need to be owned or + need to be consumed in order to perform an action.

        +
        +

        A variety of other entities refer to these as gatekeepers and payments for + actions that can be performed in game.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMaterialRequirementSetDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        materials

        + + +
        +
        +

        The list of all materials that are required.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestone.html b/docs/interfaces/destinymilestone.html new file mode 100644 index 0000000..7d921a3 --- /dev/null +++ b/docs/interfaces/destinymilestone.html @@ -0,0 +1,431 @@ + + + + + + DestinyMilestone | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestone

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents a runtime instance of a user's milestone status. Live Milestone data + should be combined with DestinyMilestoneDefinition data to show the user a + picture of what is available for them to do in the game, and their status in + regards to said "things to do." Consider it a big, wonky to-do list, or Advisors + 3.0 for those who remember the Destiny 1 API.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestone +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activities

        + + +
        +
        +

        The currently active Activities in this milestone, when the Milestone is driven + by Challenges.

        +
        +

        Not all Milestones have Challenges, but when they do this will indicate the + Activities and Challenges under those Activities related to this Milestone.

        +
        +
        +
        + +

        availableQuests

        +
        availableQuests: DestinyMilestoneQuest[]
        + +
        +
        +

        Indicates what quests are available for this Milestone. Usually this will be + only a single Quest, but some quests have multiple available that you can choose + from at any given time. All possible quests for a milestone can be found in the + DestinyMilestoneDefinition, but they must be combined with this Live data to + determine which one(s) are actually active right now. It is possible for + Milestones to not have any quests.

        +
        +
        +
        +
        + +

        Optional endDate

        +
        endDate: string
        + +
        +
        +

        If known, this is the date when the event will next end or repeat. It will only + be populated for events with fixed and repeating start and end dates.

        +
        +
        +
        +
        + +

        milestoneHash

        +
        milestoneHash: number
        + +
        +
        +

        The unique identifier for the Milestone. Use it to look up the + DestinyMilestoneDefinition, so you can combine the other data in this contract + with static definition data.

        +
        +

        Mapped to DestinyMilestoneDefinition in the manifest.

        +
        +
        +
        + +

        order

        +
        order: number
        + +
        +
        +

        Used for ordering milestones in a display to match how we order them in BNet. + May pull from static data, or possibly in the future from dynamic information.

        +
        +
        +
        +
        + +

        rewards

        + + +
        +
        +

        If the entity to which this component is attached has known active Rewards for + the player, this will detail information about those rewards, keyed by the + RewardEntry Hash. (See DestinyMilestoneDefinition for more information about + Reward Entries) Note that these rewards are not for the Quests related to the + Milestone. Think of these as "overview/checklist" rewards that may be provided + for Milestones that may provide rewards for performing a variety of tasks that + aren't under a specific Quest.

        +
        +
        +
        +
        + +

        Optional startDate

        +
        startDate: string
        + +
        +
        +

        If known, this is the date when the event last began or refreshed. It will only + be populated for events with fixed and repeating start and end dates.

        +
        +
        +
        +
        + +

        values

        +
        values: object
        + +
        +
        +

        Milestones may have arbitrary key/value pairs associated with them, for data + that users will want to know about but that doesn't fit neatly into any of the + common components such as Quests. A good example of this would be - if this + existed in Destiny 1 - the number of wins you currently have on your Trials of + Osiris ticket. Looking in the DestinyMilestoneDefinition, you can use the string + identifier of this dictionary to look up more info about the value, including + localized string content for displaying the value. The value in the dictionary + is the floating point number. The definition will tell you how to format this + number.

        +
        +
        +
        +

        Type declaration

        +
          +
        • +
          [key: string]: number
          +
        • +
        +
        +
        +
        + +

        vendorHashes

        +
        vendorHashes: number[]
        + +
        +
        +

        A milestone may have one or more active vendors that are "related" to it (that + provide rewards, or that are the initiators of the Milestone). I already regret + this, even as I'm typing it. [I told you I'd regret this] You see, sometimes a + milestone may be directly correlated with a set of vendors that provide varying + tiers of rewards. The player may not be able to interact with one or more of + those vendors. This will return the hashes of the Vendors that the player can + interact with, allowing you to show their current inventory as rewards or + related items to the Milestone or its activities.

        +
        +

        Before we even use it, it's already deprecated! How much of a bummer is that? We + need more data.

        +

        Mapped to DestinyVendorDefinition in the manifest.

        +
        +
        +
        + +

        vendors

        + + +
        +
        +

        Replaces vendorHashes, which I knew was going to be trouble the day it walked in + the door. This will return not only what Vendors are active and relevant to the + activity (in an implied order that you can choose to ignore), but also other + data - for example, if the Vendor is featuring a specific item relevant to this + event that you should show with them.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestoneactivity.html b/docs/interfaces/destinymilestoneactivity.html new file mode 100644 index 0000000..0a425a5 --- /dev/null +++ b/docs/interfaces/destinymilestoneactivity.html @@ -0,0 +1,305 @@ + + + + + + DestinyMilestoneActivity | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneActivity

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Sometimes, we know the specific activity that the Milestone wants you to play. + This entity provides additional information about that Activity and all of its + variants. (sometimes there's only one variant, but I think you get the point)

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneActivity +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activityHash

        +
        activityHash: number
        + +
        +
        +

        The hash of an arbitrarily chosen variant of this activity. We'll go ahead and + call that the "canonical" activity, because if you're using this value you + should only use it for properties that are common across the variants: things + like the name of the activity, it's location, etc... Use this hash to look up + the DestinyActivityDefinition of this activity for rendering data.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        Optional activityModeHash

        +
        activityModeHash: number
        + +
        +
        +

        The hash identifier of the most specific Activity Mode under which this activity + is played. This is useful for situations where the activity in question is - for + instance - a PVP map, but it's not clear what mode the PVP map is being played + under. If it's a playlist, this will be less specific: but hopefully useful in + some way.

        +
        +

        Mapped to DestinyActivityModeDefinition in the manifest.

        +
        +
        +
        + +

        Optional activityModeType

        +
        activityModeType: number
        + +
        +
        +

        The enumeration equivalent of the most specific Activity Mode under which this + activity is played.

        +
        +
        +
        +
        + +

        modifierHashes

        +
        modifierHashes: number[]
        + +
        +
        +

        If the activity has modifiers, this will be the list of modifiers that all + variants have in common. Perform lookups against + DestinyActivityModifierDefinition which defines the modifier being applied to + get at the modifier data. Note that, in the DestiyActivityDefinition, you will + see many more modifiers than this being referred to: those are all possible + modifiers for the activity, not the active ones. Use only the active ones to + match what's really live.

        +
        +

        Mapped to DestinyActivityModifierDefinition in the manifest.

        +
        +
        +
        + +

        variants

        + + +
        +
        +

        If you want more than just name/location/etc... you're going to have to dig into + and show the variants of the conceptual activity. These will differ in seemingly + arbitrary ways, like difficulty level and modifiers applied. Show it in whatever + way tickles your fancy.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestoneactivitycompletionstatus.html b/docs/interfaces/destinymilestoneactivitycompletionstatus.html new file mode 100644 index 0000000..eee7a1b --- /dev/null +++ b/docs/interfaces/destinymilestoneactivitycompletionstatus.html @@ -0,0 +1,232 @@ + + + + + + DestinyMilestoneActivityCompletionStatus | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneActivityCompletionStatus

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents this player's personal completion status for the Activity under a + Milestone, if the activity has trackable completion and progress information. ( + most activities won't, or the concept won't apply. For instance, it makes sense + to talk about a tier of a raid as being Completed or having progress, but it + doesn't make sense to talk about a Crucible Playlist in those terms.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneActivityCompletionStatus +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        completed

        +
        completed: boolean
        + +
        +
        +

        If the activity has been "completed", that information will be returned here.

        +
        +
        +
        +
        + +

        phases

        + + +
        +
        +

        If the Activity has discrete "phases" that we can track, that info will be here. + Otherwise, this value will be NULL. Note that this is a list and not a + dictionary: the order implies the ascending order of phases or progression in + this activity.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestoneactivitydefinition.html b/docs/interfaces/destinymilestoneactivitydefinition.html new file mode 100644 index 0000000..5674940 --- /dev/null +++ b/docs/interfaces/destinymilestoneactivitydefinition.html @@ -0,0 +1,251 @@ + + + + + + DestinyMilestoneActivityDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneActivityDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Milestones can have associated activities which provide additional information + about the context, challenges, modifiers, state etc... related to this Milestone.

        +
        +

        Information we need to be able to return that data is defined here, along with + Tier data to establish a relationship between a conceptual Activity and its + difficulty levels and variants.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneActivityDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        conceptualActivityHash

        +
        conceptualActivityHash: number
        + +
        +
        +

        The "Conceptual" activity hash. Basically, we picked the lowest level activity + and are treating it as the canonical definition of the activity for rendering + purposes.

        +
        +

        If you care about the specific difficulty modes and variations, use the + activities under "Variants".

        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        variants

        +
        variants: object
        + +
        +
        +

        A milestone-referenced activity can have many variants, such as Tiers or + alternative modes of play.

        +
        +

        Even if there is only a single variant, the details for these are represented + within as a variant definition.

        +

        It is assumed that, if this DestinyMilestoneActivityDefinition is active, then + all variants should be active.

        +

        If a Milestone could ever split the variants' active status conditionally, they + should all have their own DestinyMilestoneActivityDefinition instead! The + potential duplication will be worth it for the obviousness of processing and use.

        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestoneactivityphase.html b/docs/interfaces/destinymilestoneactivityphase.html new file mode 100644 index 0000000..b89942c --- /dev/null +++ b/docs/interfaces/destinymilestoneactivityphase.html @@ -0,0 +1,230 @@ + + + + + + DestinyMilestoneActivityPhase | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneActivityPhase

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents whatever information we can return about an explicit phase in an + activity. In the future, I hope we'll have more than just "guh, you done gone + and did something," but for the forseeable future that's all we've got. I'm + making it more than just a list of booleans out of that overly-optimistic hope.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneActivityPhase +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        complete

        +
        complete: boolean
        + +
        +
        +

        Indicates if the phase has been completed.

        +
        +
        +
        +
        + +

        phaseHash

        +
        phaseHash: number
        + +
        +
        +

        In DestinyActivityDefinition, if the activity has phases, there will be a set of + phases defined in the "insertionPoints" property. This is the hash that maps to + that phase.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestoneactivityvariant.html b/docs/interfaces/destinymilestoneactivityvariant.html new file mode 100644 index 0000000..017a3d8 --- /dev/null +++ b/docs/interfaces/destinymilestoneactivityvariant.html @@ -0,0 +1,274 @@ + + + + + + DestinyMilestoneActivityVariant | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneActivityVariant

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents custom data that we know about an individual variant of an activity.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneActivityVariant +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activityHash

        +
        activityHash: number
        + +
        +
        +

        The hash for the specific variant of the activity related to this milestone. You + can pull more detailed static info from the DestinyActivityDefinition, such as + difficulty level.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        Optional activityModeHash

        +
        activityModeHash: number
        + +
        +
        +

        The hash identifier of the most specific Activity Mode under which this activity + is played. This is useful for situations where the activity in question is - for + instance - a PVP map, but it's not clear what mode the PVP map is being played + under. If it's a playlist, this will be less specific: but hopefully useful in + some way.

        +
        +

        Mapped to DestinyActivityModeDefinition in the manifest.

        +
        +
        +
        + +

        Optional activityModeType

        +
        activityModeType: number
        + +
        +
        +

        The enumeration equivalent of the most specific Activity Mode under which this + activity is played.

        +
        +
        +
        +
        + +

        completionStatus

        + + +
        +
        +

        An OPTIONAL component: if it makes sense to talk about this activity variant in + terms of whether or not it has been completed or what progress you have made in + it, this will be returned. Otherwise, this will be NULL.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestoneactivityvariantdefinition.html b/docs/interfaces/destinymilestoneactivityvariantdefinition.html new file mode 100644 index 0000000..e4f0a9f --- /dev/null +++ b/docs/interfaces/destinymilestoneactivityvariantdefinition.html @@ -0,0 +1,235 @@ + + + + + + DestinyMilestoneActivityVariantDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneActivityVariantDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents a variant on an activity for a Milestone: a specific difficulty tier, + or a specific activity variant for example.

        +
        +

        These will often have more specific details, such as an associated Guided Game, + progression steps, tier-specific rewards, and custom values.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneActivityVariantDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activityHash

        +
        activityHash: number
        + +
        +
        +

        The hash to use for looking up the variant Activity's definition ( + DestinyActivityDefinition), where you can find its distinguishing + characteristics such as difficulty level and recommended light level.

        +
        +

        Frequently, that will be the only distinguishing characteristics in practice, + which is somewhat of a bummer.

        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        order

        +
        order: number
        + +
        +
        +

        If you care to do so, render the variants in the order prescribed by this value.

        +
        +

        When you combine live Milestone data with the definition, the order becomes more + useful because you'll be cross-referencing between the definition and live data.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonechallengeactivity.html b/docs/interfaces/destinymilestonechallengeactivity.html new file mode 100644 index 0000000..ef8e7f1 --- /dev/null +++ b/docs/interfaces/destinymilestonechallengeactivity.html @@ -0,0 +1,321 @@ + + + + + + DestinyMilestoneChallengeActivity | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneChallengeActivity

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneChallengeActivity +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activityHash

        +
        activityHash: number
        + +
        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        +
        + +

        booleanActivityOptions

        +
        booleanActivityOptions: object
        + +
        +
        +

        The set of activity options for this activity, keyed by an identifier that's + unique for this activity (not guaranteed to be unique between or across all + activities, though should be unique for every variant of a given conceptual + activity: for instance, the original D2 Raid has many variant + DestinyActivityDefinitions. While other activities could potentially have the + same option hashes, for any given D2 base Raid variant the hash will be unique).

        +
        +

        As a concrete example of this data, the hashes you get for Raids will correspond + to the currently active "Challenge Mode".

        +

        We don't have any human readable information for these, but saavy 3rd party app + users could manually associate the key (a hash identifier for the "option" that + is enabled/disabled) and the value (whether it's enabled or disabled presently)

        +

        On our side, we don't necessarily even know what these are used for (the game + designers know, but we don't), and we have no human readable data for them. In + order to use them, you will have to do some experimentation.

        +
        +
        +

        Type declaration

        +
          +
        • +
          [key: number]: boolean
          +
        • +
        +
        +
        +
        + +

        challenges

        + + +
        +
        + +

        Optional loadoutRequirementIndex

        +
        loadoutRequirementIndex: number
        + +
        +
        +

        If returned, this is the index into the DestinyActivityDefinition's "loadouts" + property, indicating the currently active loadout requirements.

        +
        +
        +
        +
        + +

        modifierHashes

        +
        modifierHashes: number[]
        + +
        +
        +

        If the activity has modifiers, this will be the list of modifiers that all + variants have in common. Perform lookups against + DestinyActivityModifierDefinition which defines the modifier being applied to + get at the modifier data.

        +
        +

        Note that, in the DestiyActivityDefinition, you will see many more modifiers + than this being referred to: those are all possible modifiers for the activity, + not the active ones. Use only the active ones to match what's really live.

        +

        Mapped to DestinyActivityModifierDefinition in the manifest.

        +
        +
        +
        + +

        phases

        + + +
        +
        +

        If the Activity has discrete "phases" that we can track, that info will be here. + Otherwise, this value will be NULL. Note that this is a list and not a + dictionary: the order implies the ascending order of phases or progression in + this activity.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonechallengeactivitydefinition.html b/docs/interfaces/destinymilestonechallengeactivitydefinition.html new file mode 100644 index 0000000..fa68995 --- /dev/null +++ b/docs/interfaces/destinymilestonechallengeactivitydefinition.html @@ -0,0 +1,254 @@ + + + + + + DestinyMilestoneChallengeActivityDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneChallengeActivityDefinition

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneChallengeActivityDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activityGraphNodes

        + + +
        +
        +

        If the activity and its challenge is visible on any of these nodes, it will be + returned.

        +
        +
        +
        +
        + +

        activityHash

        +
        activityHash: number
        + +
        +
        +

        The activity for which this challenge is active.

        +
        +
        +
        +
        + +

        challenges

        + + +
        +
        + +

        phases

        + + +
        +
        +

        Phases related to this activity, if there are any.

        +
        +

        These will be listed in the order in which they will appear in the actual + activity.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonechallengeactivitygraphnodeentry.html b/docs/interfaces/destinymilestonechallengeactivitygraphnodeentry.html new file mode 100644 index 0000000..031ca3e --- /dev/null +++ b/docs/interfaces/destinymilestonechallengeactivitygraphnodeentry.html @@ -0,0 +1,208 @@ + + + + + + DestinyMilestoneChallengeActivityGraphNodeEntry | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneChallengeActivityGraphNodeEntry

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneChallengeActivityGraphNodeEntry +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activityGraphHash

        +
        activityGraphHash: number
        + +
        +
        + +

        activityGraphNodeHash

        +
        activityGraphNodeHash: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonechallengeactivityphase.html b/docs/interfaces/destinymilestonechallengeactivityphase.html new file mode 100644 index 0000000..6ad2624 --- /dev/null +++ b/docs/interfaces/destinymilestonechallengeactivityphase.html @@ -0,0 +1,199 @@ + + + + + + DestinyMilestoneChallengeActivityPhase | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneChallengeActivityPhase

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneChallengeActivityPhase +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        phaseHash

        +
        phaseHash: number
        + +
        +
        +

        The hash identifier of the activity's phase.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonechallengedefinition.html b/docs/interfaces/destinymilestonechallengedefinition.html new file mode 100644 index 0000000..91a6e2f --- /dev/null +++ b/docs/interfaces/destinymilestonechallengedefinition.html @@ -0,0 +1,199 @@ + + + + + + DestinyMilestoneChallengeDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneChallengeDefinition

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneChallengeDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        challengeObjectiveHash

        +
        challengeObjectiveHash: number
        + +
        +
        +

        The challenge related to this milestone.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonecontent.html b/docs/interfaces/destinymilestonecontent.html new file mode 100644 index 0000000..0308222 --- /dev/null +++ b/docs/interfaces/destinymilestonecontent.html @@ -0,0 +1,268 @@ + + + + + + DestinyMilestoneContent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneContent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents localized, extended content related to Milestones. This is + intentionally returned by a separate endpoint and not with Character-level + Milestone data because we do not put localized data into standard Destiny + responses, both for brevity of response and for caching purposes. If you really + need this data, hit the Milestone Content endpoint.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneContent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        about

        +
        about: string
        + +
        +
        +

        The "About this Milestone" text from the Firehose.

        +
        +
        +
        +
        + +

        itemCategories

        + + +
        +
        +

        If DPS has defined items related to this Milestone, they can categorize those + items in the Firehose. That data will then be returned as item categories here.

        +
        +
        +
        +
        + +

        status

        +
        status: string
        + +
        +
        +

        The Current Status of the Milestone, as driven by the Firehose.

        +
        +
        +
        +
        + +

        tips

        +
        tips: string[]
        + +
        +
        +

        A list of tips, provided by the Firehose.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonecontentitemcategory.html b/docs/interfaces/destinymilestonecontentitemcategory.html new file mode 100644 index 0000000..e81f694 --- /dev/null +++ b/docs/interfaces/destinymilestonecontentitemcategory.html @@ -0,0 +1,222 @@ + + + + + + DestinyMilestoneContentItemCategory | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneContentItemCategory

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Part of our dynamic, localized Milestone content is arbitrary categories of + items. These are built in our content management system, and thus aren't the + same as programmatically generated rewards.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneContentItemCategory +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        itemHashes

        +
        itemHashes: number[]
        + +
        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        +
        + +

        title

        +
        title: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonedefinition.html b/docs/interfaces/destinymilestonedefinition.html new file mode 100644 index 0000000..5be4942 --- /dev/null +++ b/docs/interfaces/destinymilestonedefinition.html @@ -0,0 +1,664 @@ + + + + + + DestinyMilestoneDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Milestones are an in-game concept where they're attempting to tell you what you + can do next in-game.

        +
        +

        If that sounds a lot like Advisors in Destiny 1, it is! So we threw out Advisors + in the Destiny 2 API and tacked all of the data we would have put on Advisors + onto Milestones instead.

        +

        Each Milestone represents something going on in the game right now:

        +
          +
        • A "ritual activity" you can perform, like nightfall

          +
        • +
        • A "special event" that may have activities related to it, like Taco Tuesday ( + there's no Taco Tuesday in Destiny 2)

          +
        • +
        • A checklist you can fulfill, like helping your Clan complete all of its weekly + objectives

          +
        • +
        • A tutorial quest you can play through, like the introduction to the Crucible.

          +
        • +
        +

        Most of these milestones appear in game as well. Some of them are BNet only, + because we're so extra. You're welcome.

        +

        There are some important caveats to understand about how we currently render + Milestones and their deficiencies. The game currently doesn't have any content + that actually tells you oughtright what the Milestone is: that is to say, what + you'll be doing. The best we get is either a description of the overall + Milestone, or of the Quest that the Milestone is having you partake in: which is + usually something that assumes you already know what it's talking about, like " + Complete 5 Challenges". 5 Challenges for what? What's a challenge? These are not + questions that the Milestone data will answer for you unfortunately.

        +

        This isn't great, and in the future I'd like to add some custom text to give you + more contextual information to pass on to your users. But for now, you can do + what we do to render what little display info we do have:

        +

        Start by looking at the currently active quest (ideally, you've fetched + DestinyMilestone or DestinyPublicMilestone data from the API, so you know the + currently active quest for the Milestone in question). Look up the Quests + property in the Milestone Definition, and check if it has display properties. If + it does, show that as the description of the Milestone. If it doesn't, fall back + on the Milestone's description.

        +

        This approach will let you avoid, whenever possible, the even less useful (and + sometimes nonexistant) milestone-level names and descriptions.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activities

        + + +
        +
        +

        A Milestone can now be represented by one or more activities directly (without a + backing Quest), and that activity can have many challenges, modifiers, and + related to it.

        +
        +
        +
        +
        + +

        defaultOrder

        +
        defaultOrder: number
        + +
        +
        + +

        displayProperties

        + + +
        +
        + +

        explorePrioritizesActivityImage

        +
        explorePrioritizesActivityImage: boolean
        + +
        +
        +

        If TRUE, "Explore Destiny" (the front page of BNet and the companion app) + prioritize using the activity image over any overriding Quest or Milestone image + provided. This unfortunate hack is brought to you by Trials of The Nine.

        +
        +
        +
        +
        + +

        friendlyName

        +
        friendlyName: string
        + +
        +
        +

        If the milestone has a friendly identifier for association with other features - + such as Recruiting - that identifier can be found here. This is "friendly" in + that it looks better in a URL than whatever the identifier for the Milestone + actually is.

        +
        +
        +
        +
        + +

        hasPredictableDates

        +
        hasPredictableDates: boolean
        + +
        +
        +

        A shortcut for clients - and the server - to understand whether we can predict + the start and end dates for this event. In practice, there are multiple ways + that an event could have predictable date ranges, but not all events will be + able to be predicted via any mechanism (for instance, events that are manually + triggered on and off)

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        image

        +
        image: string
        + +
        +
        +

        A custom image someone made just for the milestone. Isn't that special?

        +
        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        isInGameMilestone

        +
        isInGameMilestone: boolean
        + +
        +
        +

        Some milestones are explicit objectives that you can see and interact with in + the game. Some milestones are more conceptual, built by BNet to help advise you + on activities and events that happen in-game but that aren't explicitly shown in + game as Milestones. If this is TRUE, you can see this as a milestone in the game. + If this is FALSE, it's an event or activity you can participate in, but you won' + t see it as a Milestone in the game's UI.

        +
        +
        +
        +
        + +

        milestoneType

        +
        milestoneType: DestinyMilestoneType
        + +
        +
        +

        An enumeration listing one of the possible types of milestones. Check out the + DestinyMilestoneType enum for more info!

        +
        +
        +
        +
        + +

        quests

        +
        quests: object
        + +
        +
        +

        The full set of possible Quests that give the overview of the Milestone event/ + activity in question. Only one of these can be active at a time for a given + Conceptual Milestone, but many of them may be "available" for the user to choose + from. (for instance, with Milestones you can choose from the three available + Quests, but only one can be active at a time) Keyed by the quest item.

        +
        +

        As of Forsaken (~September 2018), Quest-style Milestones are being removed for + many types of activities. There will likely be further revisions to the + Milestone concept in the future.

        +
        +
        +

        Type declaration

        + +
        +
        +
        + +

        recruitable

        +
        recruitable: boolean
        + +
        +
        +

        If True, then the Milestone has been integrated with BNet's recruiting feature.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        rewards

        +
        rewards: object
        + +
        +
        +

        If this milestone can provide rewards, this will define the categories into + which the individual reward entries are placed.

        +
        +

        This is keyed by the Category's hash, which is only guaranteed to be unique + within a given Milestone.

        +
        +
        +

        Type declaration

        + +
        +
        +
        + +

        showInExplorer

        +
        showInExplorer: boolean
        + +
        +
        +

        If TRUE, this entry should be returned in the list of milestones for the " + Explore Destiny" (i.e. new BNet homepage) features of Bungie.net (as long as the + underlying event is active) Note that this is a property specifically used by + BNet and the companion app for the "Live Events" feature of the front page/ + welcome view: it's not a reflection of what you see in-game.

        +
        +
        +
        +
        + +

        showInMilestones

        +
        showInMilestones: boolean
        + +
        +
        +

        Determines whether we'll show this Milestone in the user's personal Milestones + list.

        +
        +
        +
        +
        + +

        values

        +
        values: object
        + +
        +
        +

        Sometimes, milestones will have arbitrary values associated with them that are + of interest to us or to third party developers. This is the collection of those + values' definitions, keyed by the identifier of the value and providing useful + definition information such as localizable names and descriptions for the value.

        +
        +
        +
        +

        Type declaration

        + +
        +
        +
        + +

        vendors

        + + +
        +
        +

        Sometimes, milestones will have rewards provided by Vendors. This definition + gives the information needed to understand which vendors are relevant, the order + in which they should be returned if order matters, and the conditions under + which the Vendor is relevant to the user.

        +
        +
        +
        +
        + +

        vendorsDisplayTitle

        +
        vendorsDisplayTitle: string
        + +
        +
        +

        If you're going to show Vendors for the Milestone, you can use this as a + localized "header" for the section where you show that vendor data. It'll + provide a more context-relevant clue about what the vendor's role is in the + Milestone.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonequest.html b/docs/interfaces/destinymilestonequest.html new file mode 100644 index 0000000..96724f3 --- /dev/null +++ b/docs/interfaces/destinymilestonequest.html @@ -0,0 +1,281 @@ + + + + + + DestinyMilestoneQuest | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneQuest

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If a Milestone has one or more Quests, this will contain the live information + for the character's status with one of those quests.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneQuest +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activity

        + + +
        +
        +

        IF the Milestone has an active Activity that can give you greater details + about what you need to do, it will be returned here. Remember to associate this + with the DestinyMilestoneDefinition's activities to get details about the + activity, including what specific quest it is related to if you have multiple + quests to choose from.

        +
        +
        +
        +
        + +

        challenges

        + + +
        +
        +

        The activities referred to by this quest can have many associated challenges. + They are all contained here, with activityHashes so that you can associate them + with the specific activity variants in which they can be found. In retrospect, I + probably should have put these under the specific Activity Variants, but it's + too late to change it now. Theoretically, a quest without Activities can still + have Challenges, which is why this is on a higher level than activity/variants, + but it probably should have been in both places. That may come as a later + revision.

        +
        +
        +
        +
        + +

        questItemHash

        +
        questItemHash: number
        + +
        +
        +

        Quests are defined as Items in content. As such, this is the hash identifier of + the DestinyInventoryItemDefinition that represents this quest. It will have + pointers to all of the steps in the quest, and display information for the quest + (title, description, icon etc) Individual steps will be referred to in the Quest + item's DestinyInventoryItemDefinition.setData property, and themselves are Items + with their own renderable data.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        status

        + + +
        +
        +

        The current status of the quest for the character making the request.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonequestdefinition.html b/docs/interfaces/destinymilestonequestdefinition.html new file mode 100644 index 0000000..b9ed4c3 --- /dev/null +++ b/docs/interfaces/destinymilestonequestdefinition.html @@ -0,0 +1,328 @@ + + + + + + DestinyMilestoneQuestDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneQuestDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Any data we need to figure out whether this Quest Item is the currently active + one for the conceptual Milestone. Even just typing this description, I already + regret it.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneQuestDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activities

        +
        activities: object
        + +
        +
        +

        The full set of all possible "conceptual activities" that are related to this + Milestone. Tiers or alternative modes of play within these conceptual activities + will be defined as sub-entities. Keyed by the Conceptual Activity Hash. Use the + key to look up DestinyActivityDefinition.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +

        Type declaration

        + +
        +
        +
        + +

        Optional destinationHash

        +
        destinationHash: number
        + +
        +
        +

        Sometimes, a Milestone's quest is related to an entire Destination rather than a + specific activity. In that situation, this will be the hash of that Destination. + Hotspots are currently the only Milestones that expose this data, but that does + not preclude this data from being returned for other Milestones in the future.

        +
        +

        Mapped to DestinyDestinationDefinition in the manifest.

        +
        +
        +
        + +

        displayProperties

        + + +
        +
        +

        The individual quests may have different definitions from the overall milestone: + if there's a specific active quest, use these displayProperties instead of that + of the overall DestinyMilestoneDefinition.

        +
        +
        +
        +
        + +

        overrideImage

        +
        overrideImage: string
        + +
        +
        +

        If populated, this image can be shown instead of the generic milestone's image + when this quest is live, or it can be used to show a background image for the + quest itself that differs from that of the Activity or the Milestone.

        +
        +
        +
        +
        + +

        questItemHash

        +
        questItemHash: number
        + +
        +
        +

        The item representing this Milestone quest. Use this hash to look up the + DestinyInventoryItemDefinition for the quest to find its steps and human + readable data.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        questRewards

        + + +
        +
        +

        The rewards you will get for completing this quest, as best as we could extract + them from our data. Sometimes, it'll be a decent amount of data. Sometimes, it's + going to be sucky. Sorry.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonequestrewarditem.html b/docs/interfaces/destinymilestonequestrewarditem.html new file mode 100644 index 0000000..8117913 --- /dev/null +++ b/docs/interfaces/destinymilestonequestrewarditem.html @@ -0,0 +1,294 @@ + + + + + + DestinyMilestoneQuestRewardItem | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneQuestRewardItem

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A subclass of DestinyItemQuantity, that provides not just the item and its + quantity but also information that BNet can - at some point - use internally to + provide more robust runtime information about the item's qualities.

        +
        +

        If you want it, please ask! We're just out of time to wire it up right now. Or a + clever person just may do it with our existing endpoints.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneQuestRewardItem +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        itemHash

        +
        itemHash: number
        + +
        +
        +

        The hash identifier for the item in question. Use it to look up the item's + DestinyInventoryItemDefinition.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        Optional itemInstanceId

        +
        itemInstanceId: string
        + +
        +
        +

        If this quantity is referring to a specific instance of an item, this will have + the item's instance ID. Normally, this will be null.

        +
        +
        +
        +
        + +

        quantity

        +
        quantity: number
        + +
        +
        +

        The amount of the item needed/available depending on the context of where + DestinyItemQuantity is being used.

        +
        +
        +
        +
        + +

        Optional vendorHash

        +
        vendorHash: number
        + +
        +
        +

        The quest reward item may be associated with a vendor. If so, this is that + vendor. Use this hash to look up the DestinyVendorDefinition.

        +
        +

        Mapped to DestinyVendorDefinition in the manifest.

        +
        +
        +
        + +

        Optional vendorItemIndex

        +
        vendorItemIndex: number
        + +
        +
        +

        The quest reward item may be associated with a vendor. If so, this is the + index of the item being sold, which we can use at runtime to find instanced item + information for the reward item.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonequestrewardsdefinition.html b/docs/interfaces/destinymilestonequestrewardsdefinition.html new file mode 100644 index 0000000..7168d85 --- /dev/null +++ b/docs/interfaces/destinymilestonequestrewardsdefinition.html @@ -0,0 +1,217 @@ + + + + + + DestinyMilestoneQuestRewardsDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneQuestRewardsDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If rewards are given in a quest - as opposed to overall in the entire Milestone - + there's way less to track. We're going to simplify this contract as a result. + However, this also gives us the opportunity to potentially put more than just + item information into the reward data if we're able to mine it out in the future. + Remember this if you come back and ask "why are quest reward items nested + inside of their own class?"

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneQuestRewardsDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        items

        + + +
        +
        +

        The items that represent your reward for completing the quest.

        +
        +

        Be warned, these could be "dummy" items: items that are only used to render a + good-looking in-game tooltip, but aren't the actual items themselves.

        +

        For instance, when experience is given there's often a dummy item representing " + experience", with quantity being the amount of experience you got. We don't have + a programmatic association between those and whatever Progression is actually + getting that experience... yet.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonerewardcategory.html b/docs/interfaces/destinymilestonerewardcategory.html new file mode 100644 index 0000000..77d1cc4 --- /dev/null +++ b/docs/interfaces/destinymilestonerewardcategory.html @@ -0,0 +1,227 @@ + + + + + + DestinyMilestoneRewardCategory | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneRewardCategory

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents a category of "summary" rewards that can be earned for the Milestone + regardless of specific quest rewards that can be earned.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneRewardCategory +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        entries

        + + +
        +
        +

        The individual reward entries for this category, and their status.

        +
        +
        +
        +
        + +

        rewardCategoryHash

        +
        rewardCategoryHash: number
        + +
        +
        +

        Look up the relevant DestinyMilestoneDefinition, and then use rewardCategoryHash + to look up the category info in DestinyMilestoneDefinition.rewards.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonerewardcategorydefinition.html b/docs/interfaces/destinymilestonerewardcategorydefinition.html new file mode 100644 index 0000000..0d713f3 --- /dev/null +++ b/docs/interfaces/destinymilestonerewardcategorydefinition.html @@ -0,0 +1,298 @@ + + + + + + DestinyMilestoneRewardCategoryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneRewardCategoryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The definition of a category of rewards, that contains many individual rewards.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneRewardCategoryDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        categoryHash

        +
        categoryHash: number
        + +
        +
        +

        Identifies the reward category. Only guaranteed unique within this specific + component!

        +
        +
        +
        +
        + +

        categoryIdentifier

        +
        categoryIdentifier: string
        + +
        +
        +

        The string identifier for the category, if you want to use it for some end. + Guaranteed unique within the specific component.

        +
        +
        +
        +
        + +

        displayProperties

        + + +
        +
        +

        Hopefully this is obvious by now.

        +
        +
        +
        +
        + +

        order

        +
        order: number
        + +
        +
        +

        If you want to use BNet's recommended order for rendering categories + programmatically, use this value and compare it to other categories to determine + the order in which they should be rendered. I don't feel great about putting + this here, I won't lie.

        +
        +
        +
        +
        + +

        rewardEntries

        +
        rewardEntries: object
        + +
        +
        +

        If this milestone can provide rewards, this will define the sets of rewards that + can be earned, the conditions under which they can be acquired, internal data + that we'll use at runtime to determine whether you've already earned or redeemed + this set of rewards, and the category that this reward should be placed under.

        +
        +
        +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonerewardentry.html b/docs/interfaces/destinymilestonerewardentry.html new file mode 100644 index 0000000..ef2da79 --- /dev/null +++ b/docs/interfaces/destinymilestonerewardentry.html @@ -0,0 +1,250 @@ + + + + + + DestinyMilestoneRewardEntry | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneRewardEntry

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The character-specific data for a milestone's reward entry. See + DestinyMilestoneDefinition for more information about Reward Entries.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneRewardEntry +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        earned

        +
        earned: boolean
        + +
        +
        +

        If TRUE, the player has earned this reward.

        +
        +
        +
        +
        + +

        redeemed

        +
        redeemed: boolean
        + +
        +
        +

        If TRUE, the player has redeemed/picked up/obtained this reward. Feel free to + alias this to "gotTheShinyBauble" in your own codebase.

        +
        +
        +
        +
        + +

        rewardEntryHash

        +
        rewardEntryHash: number
        + +
        +
        +

        The identifier for the reward entry in question. It is important to look up the + related DestinyMilestoneRewardEntryDefinition to get the static details about + the reward, which you can do by looking up the milestone's + DestinyMilestoneDefinition and examining the DestinyMilestoneDefinition.rewards[ + rewardCategoryHash].rewardEntries[rewardEntryHash] data.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonerewardentrydefinition.html b/docs/interfaces/destinymilestonerewardentrydefinition.html new file mode 100644 index 0000000..15c79d7 --- /dev/null +++ b/docs/interfaces/destinymilestonerewardentrydefinition.html @@ -0,0 +1,310 @@ + + + + + + DestinyMilestoneRewardEntryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneRewardEntryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The definition of a specific reward, which may be contained in a category of + rewards and that has optional information about how it is obtained.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneRewardEntryDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        +

        For us to bother returning this info, we should be able to return some kind of + information about why these rewards are grouped together. This is ideally that + information. Look at how confident I am that this will always remain true.

        +
        +
        +
        +
        + +

        items

        + + +
        +
        +

        The items you will get as rewards, and how much of it you'll get.

        +
        +
        +
        +
        + +

        order

        +
        order: number
        + +
        +
        +

        If you want to follow BNet's ordering of these rewards, use this number within a + given category to order the rewards. Yeah, I know. I feel dirty too.

        +
        +
        +
        +
        + +

        rewardEntryHash

        +
        rewardEntryHash: number
        + +
        +
        +

        The identifier for this reward entry. Runtime data will refer to reward entries + by this hash. Only guaranteed unique within the specific Milestone.

        +
        +
        +
        +
        + +

        rewardEntryIdentifier

        +
        rewardEntryIdentifier: string
        + +
        +
        +

        The string identifier, if you care about it. Only guaranteed unique within the + specific Milestone.

        +
        +
        +
        +
        + +

        Optional vendorHash

        +
        vendorHash: number
        + +
        +
        +

        If this reward is redeemed at a Vendor, this is the hash of the Vendor to go to + in order to redeem the reward. Use this hash to look up the + DestinyVendorDefinition.

        +
        +

        Mapped to DestinyVendorDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonevaluedefinition.html b/docs/interfaces/destinymilestonevaluedefinition.html new file mode 100644 index 0000000..27a9fc7 --- /dev/null +++ b/docs/interfaces/destinymilestonevaluedefinition.html @@ -0,0 +1,218 @@ + + + + + + DestinyMilestoneValueDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneValueDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The definition for information related to a key/value pair that is relevant for + a particular Milestone or component within the Milestone.

        +
        +

        This lets us more flexibly pass up information that's useful to someone, even if + it's not necessarily us.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneValueDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        + +

        key

        +
        key: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonevendor.html b/docs/interfaces/destinymilestonevendor.html new file mode 100644 index 0000000..949dd5c --- /dev/null +++ b/docs/interfaces/destinymilestonevendor.html @@ -0,0 +1,233 @@ + + + + + + DestinyMilestoneVendor | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneVendor

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If a Milestone has one or more Vendors that are relevant to it, this will + contain information about that vendor that you can choose to show.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneVendor +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        Optional previewItemHash

        +
        previewItemHash: number
        + +
        +
        +

        If this vendor is featuring a specific item for this event, this will be the + hash identifier of that item. I'm taking bets now on how long we go before this + needs to be a list or some other, more complex representation instead and I + deprecate this too. I'm going to go with 5 months. Calling it now, 2017-09-14 at + 9:46pm PST.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        vendorHash

        +
        vendorHash: number
        + +
        +
        +

        The hash identifier of the Vendor related to this Milestone. You can show useful + things from this, such as thier Faction icon or whatever you might care about.

        +
        +

        Mapped to DestinyVendorDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinymilestonevendordefinition.html b/docs/interfaces/destinymilestonevendordefinition.html new file mode 100644 index 0000000..8be18c4 --- /dev/null +++ b/docs/interfaces/destinymilestonevendordefinition.html @@ -0,0 +1,211 @@ + + + + + + DestinyMilestoneVendorDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyMilestoneVendorDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If the Milestone or a component has vendors whose inventories could/should be + displayed that are relevant to it, this will return the vendor in question.

        +
        +

        It also contains information we need to determine whether that vendor is + actually relevant at the moment, given the user's current state.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyMilestoneVendorDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        vendorHash

        +
        vendorHash: number
        + +
        +
        +

        The hash of the vendor whose wares should be shown as associated with the + Milestone.

        +
        +

        Mapped to DestinyVendorDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinynodeactivationrequirement.html b/docs/interfaces/destinynodeactivationrequirement.html new file mode 100644 index 0000000..a2c9b4e --- /dev/null +++ b/docs/interfaces/destinynodeactivationrequirement.html @@ -0,0 +1,238 @@ + + + + + + DestinyNodeActivationRequirement | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyNodeActivationRequirement

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Talent nodes have requirements that must be met before they can be activated.

        +
        +

        This describes the material costs, the Level of the Talent Grid's progression + required, and other conditional information that limits whether a talent node + can be activated.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyNodeActivationRequirement +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        gridLevel

        +
        gridLevel: number
        + +
        +
        +

        The Progression level on the Talent Grid required to activate this node.

        +
        +

        See DestinyTalentGridDefinition.progressionHash for the related Progression, and + read DestinyProgressionDefinition's documentation to learn more about + Progressions.

        +
        +
        +
        + +

        materialRequirementHashes

        +
        materialRequirementHashes: number[]
        + +
        +
        +

        The list of hash identifiers for material requirement sets: materials that are + required for the node to be activated. See + DestinyMaterialRequirementSetDefinition for more information about material + requirements.

        +
        +

        In this case, only a single DestinyMaterialRequirementSetDefinition will be + chosen from this list, and we won't know which one will be chosen until an + instance of the item is created.

        +

        Mapped to DestinyMaterialRequirementSetDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinynodesocketreplaceresponse.html b/docs/interfaces/destinynodesocketreplaceresponse.html new file mode 100644 index 0000000..d3da684 --- /dev/null +++ b/docs/interfaces/destinynodesocketreplaceresponse.html @@ -0,0 +1,232 @@ + + + + + + DestinyNodeSocketReplaceResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyNodeSocketReplaceResponse

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This is a bit of an odd duck. Apparently, if talent nodes steps have this data, + the game will go through on step activation and alter the first Socket it finds + on the item that has a type matching the given socket type, inserting the + indicated plug item.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyNodeSocketReplaceResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        plugItemHash

        +
        plugItemHash: number
        + +
        +
        +

        The hash identifier of the plug item that will be inserted into the socket found.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        socketTypeHash

        +
        socketTypeHash: number
        + +
        +
        +

        The hash identifier of the socket type to find amidst the item's sockets (the + item to which this talent grid is attached). See DestinyInventoryItemDefinition. + sockets.socketEntries to find the socket type of sockets on the item in question.

        +
        +

        Mapped to DestinySocketTypeDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinynodestepdefinition.html b/docs/interfaces/destinynodestepdefinition.html new file mode 100644 index 0000000..b719abb --- /dev/null +++ b/docs/interfaces/destinynodestepdefinition.html @@ -0,0 +1,566 @@ + + + + + + DestinyNodeStepDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyNodeStepDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This defines the properties of a "Talent Node Step". When you see a talent node + in game, the actual visible properties that you see (its icon, description, the + perks and stats it provides) are not provided by the Node itself, but rather by + the currently active Step on the node.

        +
        +

        When a Talent Node is activated, the currently active step's benefits are + conferred upon the item and character.

        +

        The currently active step on talent nodes are determined when an item is first + instantiated. Sometimes it is random, sometimes it is more deterministic ( + particularly when a node has only a single step).

        +

        Note that, when dealing with Talent Node Steps, you must ensure that you have + the latest version of content. stepIndex and nodeStepHash - two ways of + identifying the step within a node - are both content version dependent, and + thus are subject to change between content updates.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyNodeStepDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activationRequirement

        +
        activationRequirement: DestinyNodeActivationRequirement
        + +
        +
        +

        If the step has requirements for activation (they almost always do, if nothing + else than for the Talent Grid's Progression to have reached a certain level), + they will be defined here.

        +
        +
        +
        +
        + +

        affectsLevel

        +
        affectsLevel: boolean
        + +
        +
        +

        If true, this step can affect the level of the item. See + DestinyInventoryItemDefintion for more information about item levels and their + effect on stats.

        +
        +
        +
        +
        + +

        affectsQuality

        +
        affectsQuality: boolean
        + +
        +
        +

        If this is true, the step affects the item's Quality in some way. See + DestinyInventoryItemDefinition for more information about the meaning of Quality. + I already made a joke about Zen and the Art of Motorcycle Maintenance elsewhere + in the documentation, so I will avoid doing it again. Oops too late

        +
        +
        +
        +
        + +

        canActivateNextStep

        +
        canActivateNextStep: boolean
        + +
        +
        +

        There was a time when talent nodes could be activated multiple times, and the + effects of subsequent Steps would be compounded on each other, essentially " + upgrading" the node. We have moved away from this, but theoretically the + capability still exists.

        +
        +

        I continue to return this in case it is used in the future: if true and this + step is the current step in the node, you are allowed to activate the node a + second time to receive the benefits of the next step in the node, which will + then become the active step.

        +
        +
        +
        + +

        damageType

        +
        damageType: DamageType
        + +
        +
        +

        An enum representing a damage type granted by activating this step, if any.

        +
        +
        +
        +
        + +

        Optional damageTypeHash

        +
        damageTypeHash: number
        + +
        +
        +

        If the step provides a damage type, this will be the hash identifier used to + look up the damage type's DestinyDamageTypeDefinition.

        +
        +

        Mapped to DestinyDamageTypeDefinition in the manifest.

        +
        +
        +
        + +

        displayProperties

        + + +
        +
        +

        These are the display properties actually used to render the Talent Node. The + currently active step's displayProperties are shown.

        +
        +
        +
        +
        + +

        interactionDescription

        +
        interactionDescription: string
        + +
        +
        +

        If you can interact with this node in some way, this is the localized + description of that interaction.

        +
        +
        +
        +
        + +

        isNextStepRandom

        +
        isNextStepRandom: boolean
        + +
        +
        +

        If true, the next step to be chosen is random, and if you're allowed to activate + the next step. (if canActivateNextStep = true)

        +
        +
        +
        +
        + +

        nextStepIndex

        +
        nextStepIndex: number
        + +
        +
        +

        The stepIndex of the next step in the talent node, or -1 if this is the last + step or if the next step to be chosen is random.

        +
        +

        This doesn't really matter anymore unless canActivateNextStep begins to be used + again.

        +
        +
        +
        + +

        nodeStepHash

        +
        nodeStepHash: number
        + +
        +
        +

        The hash of this node step. Unfortunately, while it can be used to uniquely + identify the step within a node, it is also content version dependent and should + not be relied on without ensuring you have the latest vesion of content.

        +
        +
        +
        +
        + +

        perkHashes

        +
        perkHashes: number[]
        + +
        +
        +

        The list of hash identifiers for Perks (DestinySandboxPerkDefinition) that are + applied when this step is active. Perks provide a variety of benefits and + modifications - examine DestinySandboxPerkDefinition to learn more.

        +
        +

        Mapped to DestinySandboxPerkDefinition in the manifest.

        +
        +
        +
        + +

        socketReplacements

        +
        socketReplacements: DestinyNodeSocketReplaceResponse[]
        + +
        +
        +

        If this step is activated, this will be a list of information used to replace + socket items with new Plugs. See DestinyInventoryItemDefinition for more + information about sockets and plugs.

        +
        +
        +
        +
        + +

        startProgressionBarAtProgress

        +
        startProgressionBarAtProgress: number
        + +
        +
        +

        When the Talent Grid's progression reaches this value, the circular "progress + bar" that surrounds the talent node should be shown.

        +
        +

        This also indicates the lower bound of said progress bar, with the upper bound + being the progress required to reach activationRequirement.gridLevel. (at some + point I should precalculate the upper bound and put it in the definition to save + people time)

        +
        +
        +
        + +

        statHashes

        +
        statHashes: number[]
        + +
        +
        +

        When the step provides stat benefits on the item or character, this is the list + of hash identifiers for stats (DestinyStatDefinition) that are provided.

        +
        +

        Mapped to DestinyStatDefinition in the manifest.

        +
        +
        +
        + +

        stepGroups

        + + +
        +
        +

        In Destiny 1, the Armory's Perk Filtering was driven by a concept of + TalentNodeStepGroups: categorizations of talent nodes based on their + functionality. While the Armory isn't a BNet-facing thing for now, and the new + Armory will need to account for Sockets rather than Talent Nodes, this + categorization capability feels useful enough to still keep around.

        +
        +
        +
        +
        + +

        stepIndex

        +
        stepIndex: number
        + +
        +
        +

        The index of this step in the list of Steps on the Talent Node.

        +
        +

        Unfortunately, this is the closest thing we have to an identifier for the Step: + steps are not provided a content version agnostic identifier. This means that, + when you are dealing with talent nodes, you will need to first ensure that you + have the latest version of content.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyobjectivedefinition.html b/docs/interfaces/destinyobjectivedefinition.html new file mode 100644 index 0000000..2925a7c --- /dev/null +++ b/docs/interfaces/destinyobjectivedefinition.html @@ -0,0 +1,592 @@ + + + + + + DestinyObjectiveDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyObjectiveDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Defines an "Objective".

        +
        +

        An objective is a specific task you should accomplish in the game. These are + referred to by:

        +
          +
        • Quest Steps (which are DestinyInventoryItemDefinition entities with Objectives)

          +
        • +
        • Challenges (which are Objectives defined on an DestinyActivityDefintion)

          +
        • +
        • Milestones (which refer to Objectives that are defined on both Quest Steps and + Activities)

          +
        • +
        • Anything else that the designers decide to do later.

          +
        • +
        +

        Objectives have progress, a notion of having been Completed, human readable data + describing the task to be accomplished, and a lot of optional tack-on data that + can enhance the information provided about the task.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyObjectiveDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        allowNegativeValue

        +
        allowNegativeValue: boolean
        + +
        +
        +

        If true, the value is allowed to go negative.

        +
        +
        +
        +
        + +

        allowOvercompletion

        +
        allowOvercompletion: boolean
        + +
        +
        +

        If True, the progress will continue even beyond the point where the objective + met its minimum completion requirements. Your UI will have to accommodate it.

        +
        +
        +
        +
        + +

        allowValueChangeWhenCompleted

        +
        allowValueChangeWhenCompleted: boolean
        + +
        +
        +

        If true, you can effectively "un-complete" this objective if you lose progress + after crossing the completion threshold.

        +
        +

        If False, once you complete the task it will remain completed forever by locking + the value.

        +
        +
        +
        + +

        completedValueStyle

        +
        completedValueStyle: DestinyUnlockValueUIStyle
        + +
        +
        +

        The style to use when the objective is completed.

        +
        +
        +
        +
        + +

        completionValue

        +
        completionValue: number
        + +
        +
        +

        The value that the unlock value defined in unlockValueHash must reach in order + for the objective to be considered Completed. Used in calculating progress and + completion status.

        +
        +
        +
        +
        + +

        displayProperties

        + + +
        +
        +

        Ideally, this should tell you what your task is. I'm not going to lie to you + though. Sometimes this doesn't have useful information at all. Which sucks, but + there's nothing either of us can do about it.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        inProgressValueStyle

        +
        inProgressValueStyle: DestinyUnlockValueUIStyle
        + +
        +
        +

        The style to use when the objective is still in progress.

        +
        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        isCountingDownward

        +
        isCountingDownward: boolean
        + +
        +
        +

        If true, completion means having an unlock value less than or equal to the + completionValue.

        +
        +

        If False, completion means having an unlock value greater than or equal to the + completionValue.

        +
        +
        +
        + +

        locationHash

        +
        locationHash: number
        + +
        +
        +

        OPTIONAL: a hash identifier for the location at which this objective must be + accomplished, if there is a location defined. Look up the + DestinyLocationDefinition for this hash for that additional location info.

        +
        +

        Mapped to DestinyLocationDefinition in the manifest.

        +
        +
        +
        + +

        minimumVisibilityThreshold

        +
        minimumVisibilityThreshold: number
        + +
        +
        +

        If nonzero, this is the minimum value at which the objective's progression + should be shown. Otherwise, don't show it yet.

        +
        +
        +
        +
        + +

        perks

        + + +
        +
        +

        If this objective enables Perks intrinsically, the conditions for that enabling + are defined here.

        +
        +
        +
        +
        + +

        progressDescription

        +
        progressDescription: string
        + +
        +
        +

        Text to describe the progress bar.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        scope

        + + +
        +
        +

        A shortcut for determining the most restrictive gating that this Objective is + set to use. This includes both the dynamic determination of progress and of + completion values. See the DestinyGatingScope enum's documentation for more + details.

        +
        +
        +
        +
        + +

        showValueOnComplete

        +
        showValueOnComplete: boolean
        + +
        +
        +

        If True, you should continue showing the progression value in the UI after it's + complete. I mean, we already do that in BNet anyways, but if you want to be + better behaved than us you could honor this flag.

        +
        +
        +
        +
        + +

        stats

        + + +
        +
        +

        If this objective enables modifications on a player's stats intrinsically, the + conditions are defined here.

        +
        +
        +
        +
        + +

        valueStyle

        + + +
        +
        +

        The UI style applied to the objective. It's an enum, take a look at + DestinyUnlockValueUIStyle for details of the possible styles. Use this info as + you wish to customize your UI.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyobjectivedisplayproperties.html b/docs/interfaces/destinyobjectivedisplayproperties.html new file mode 100644 index 0000000..9c878dc --- /dev/null +++ b/docs/interfaces/destinyobjectivedisplayproperties.html @@ -0,0 +1,219 @@ + + + + + + DestinyObjectiveDisplayProperties | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyObjectiveDisplayProperties

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyObjectiveDisplayProperties +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        Optional activityHash

        +
        activityHash: number
        + +
        +
        +

        The activity associated with this objective in the context of this item, if any.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        displayOnItemPreviewScreen

        +
        displayOnItemPreviewScreen: boolean
        + +
        +
        +

        If true, the game shows this objective on item preview screens.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyobjectiveperkentrydefinition.html b/docs/interfaces/destinyobjectiveperkentrydefinition.html new file mode 100644 index 0000000..e36b084 --- /dev/null +++ b/docs/interfaces/destinyobjectiveperkentrydefinition.html @@ -0,0 +1,231 @@ + + + + + + DestinyObjectivePerkEntryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyObjectivePerkEntryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Defines the conditions under which an intrinsic perk is applied while + participating in an Objective.

        +
        +

        These perks will generally not be benefit-granting perks, but rather a perk that + modifies gameplay in some interesting way.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyObjectivePerkEntryDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        perkHash

        +
        perkHash: number
        + +
        +
        +

        The hash identifier of the DestinySandboxPerkDefinition that will be applied to + the character.

        +
        +

        Mapped to DestinySandboxPerkDefinition in the manifest.

        +
        +
        +
        + +

        style

        + + +
        +
        +

        An enumeration indicating whether it will be applied as long as the Objective is + active, when it's completed, or until it's completed.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyobjectiveprogress.html b/docs/interfaces/destinyobjectiveprogress.html new file mode 100644 index 0000000..2147d7d --- /dev/null +++ b/docs/interfaces/destinyobjectiveprogress.html @@ -0,0 +1,343 @@ + + + + + + DestinyObjectiveProgress | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyObjectiveProgress

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Returns data about a character's status with a given Objective. Combine with + DestinyObjectiveDefinition static data for display purposes.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyObjectiveProgress +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        Optional activityHash

        +
        activityHash: number
        + +
        +
        +

        If the Objective has an Activity associated with it, this is the unique + identifier of the Activity being referred to. Use to look up the + DestinyActivityDefinition in static data. This will give localized data about * + what* you should be playing for the objective to be achieved.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        complete

        +
        complete: boolean
        + +
        +
        +

        Whether or not the Objective is completed.

        +
        +
        +
        +
        + +

        completionValue

        +
        completionValue: number
        + +
        +
        +

        As of Forsaken, objectives' completion value is determined dynamically at + runtime.

        +
        +

        This value represents the threshold of progress you need to surpass in order for + this objective to be considered "complete".

        +

        If you were using objective data, switch from using the + DestinyObjectiveDefinition's "completionValue" to this value.

        +
        +
        +
        + +

        Optional destinationHash

        +
        destinationHash: number
        + +
        +
        +

        If the Objective has a Destination associated with it, this is the unique + identifier of the Destination being referred to. Use to look up the + DestinyDestinationDefinition in static data. This will give localized data about + where in the universe the objective should be achieved.

        +
        +

        Mapped to DestinyDestinationDefinition in the manifest.

        +
        +
        +
        + +

        objectiveHash

        +
        objectiveHash: number
        + +
        +
        +

        The unique identifier of the Objective being referred to. Use to look up the + DestinyObjectiveDefinition in static data.

        +
        +

        Mapped to DestinyObjectiveDefinition in the manifest.

        +
        +
        +
        + +

        Optional progress

        +
        progress: number
        + +
        +
        +

        If progress has been made, and the progress can be measured numerically, this + will be the value of that progress. You can compare it to the + DestinyObjectiveDefinition.completionValue property for current vs. upper bounds, + and use DestinyObjectiveDefinition.valueStyle to determine how this should be + rendered. Note that progress, in Destiny 2, need not be a literal numeric + progression. It could be one of a number of possible values, even a Timestamp. + Always examine DestinyObjectiveDefinition.valueStyle before rendering progress.

        +
        +
        +
        +
        + +

        visible

        +
        visible: boolean
        + +
        +
        +

        If this is true, the objective is visible in-game. Otherwise, it's not yet + visible to the player. Up to you if you want to honor this property.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyobjectivestatentrydefinition.html b/docs/interfaces/destinyobjectivestatentrydefinition.html new file mode 100644 index 0000000..9fd36c4 --- /dev/null +++ b/docs/interfaces/destinyobjectivestatentrydefinition.html @@ -0,0 +1,227 @@ + + + + + + DestinyObjectiveStatEntryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyObjectiveStatEntryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Defines the conditions under which stat modifications will be applied to a + Character while participating in an objective.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyObjectiveStatEntryDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        stat

        + + +
        +
        +

        The stat being modified, and the value used.

        +
        +
        +
        +
        + +

        style

        + + +
        +
        +

        Whether it will be applied as long as the objective is active, when it's + completed, or until it's completed.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyparentitemoverride.html b/docs/interfaces/destinyparentitemoverride.html new file mode 100644 index 0000000..93c3c57 --- /dev/null +++ b/docs/interfaces/destinyparentitemoverride.html @@ -0,0 +1,208 @@ + + + + + + DestinyParentItemOverride | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyParentItemOverride

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyParentItemOverride +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        additionalEquipRequirementsDisplayStrings

        +
        additionalEquipRequirementsDisplayStrings: string[]
        + +
        +
        + +

        pipIcon

        +
        pipIcon: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyperkreference.html b/docs/interfaces/destinyperkreference.html new file mode 100644 index 0000000..ec726d8 --- /dev/null +++ b/docs/interfaces/destinyperkreference.html @@ -0,0 +1,273 @@ + + + + + + DestinyPerkReference | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPerkReference

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        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.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPerkReference +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        iconPath

        +
        iconPath: string
        + +
        +
        +

        The icon for the perk.

        +
        +
        +
        +
        + +

        isActive

        +
        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.)

        +
        +
        +
        +
        + +

        perkHash

        +
        perkHash: number
        + +
        +
        +

        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.

        +
        +

        Mapped to DestinySandboxPerkDefinition in the manifest.

        +
        +
        +
        + +

        visible

        +
        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.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyplacedefinition.html b/docs/interfaces/destinyplacedefinition.html new file mode 100644 index 0000000..27e64e2 --- /dev/null +++ b/docs/interfaces/destinyplacedefinition.html @@ -0,0 +1,265 @@ + + + + + + DestinyPlaceDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPlaceDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Okay, so Activities (DestinyActivityDefinition) take place in Destinations ( + DestinyDestinationDefinition). Destinations are part of larger locations known + as Places (you're reading its documentation right now).

        +
        +

        Places are more on the planetary scale, like "Earth" and "Your Mom."

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPlaceDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyplayer.html b/docs/interfaces/destinyplayer.html new file mode 100644 index 0000000..5c8611d --- /dev/null +++ b/docs/interfaces/destinyplayer.html @@ -0,0 +1,381 @@ + + + + + + DestinyPlayer | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPlayer

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPlayer +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        bungieNetUserInfo

        +
        bungieNetUserInfo: UserInfoCard
        + +
        +
        +

        Details about the player as they are known on BungieNet. This will be undefined + if the player has marked their credential private, or does not have a BungieNet + account.

        +
        +
        +
        +
        + +

        characterClass

        +
        characterClass: string
        + +
        +
        +

        Class of the character if applicable and available.

        +
        +
        +
        +
        + +

        characterLevel

        +
        characterLevel: number
        + +
        +
        +

        Level of the character if available. Zero if it is not available.

        +
        +
        +
        +
        + +

        clanName

        +
        clanName: string
        + +
        +
        +

        Current clan name for the player. This value may be null or an empty string if + the user does not have a clan.

        +
        +
        +
        +
        + +

        clanTag

        +
        clanTag: string
        + +
        +
        +

        Current clan tag for the player. This value may be null or an empty string if + the user does not have a clan.

        +
        +
        +
        +
        + +

        classHash

        +
        classHash: number
        + +
        +
        + +

        destinyUserInfo

        +
        destinyUserInfo: UserInfoCard
        + +
        +
        +

        Details about the player as they are known in game (platform display name, + Destiny emblem)

        +
        +
        +
        +
        + +

        emblemHash

        +
        emblemHash: number
        + +
        +
        +

        If we know the emblem's hash, this can be used to look up the player's emblem at + the time of a match when receiving PGCR data, or otherwise their currently + equipped emblem (if we are able to obtain it).

        +
        +
        +
        +
        + +

        genderHash

        +
        genderHash: number
        + +
        +
        + +

        lightLevel

        +
        lightLevel: number
        + +
        +
        +

        Light Level of the character if available. Zero if it is not available.

        +
        +
        +
        +
        + +

        raceHash

        +
        raceHash: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyplugruledefinition.html b/docs/interfaces/destinyplugruledefinition.html new file mode 100644 index 0000000..825bf71 --- /dev/null +++ b/docs/interfaces/destinyplugruledefinition.html @@ -0,0 +1,209 @@ + + + + + + DestinyPlugRuleDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPlugRuleDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Dictates a rule around whether the plug is enabled or insertable.

        +
        +

        In practice, the live Destiny data will refer to these entries by index. You can + then look up that index in the appropriate property (enabledRules or + insertionRules) to get the localized string for the failure message if it failed.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPlugRuleDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        failureMessage

        +
        failureMessage: string
        + +
        +
        +

        The localized string to show if this rule fails.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyplugsetdefinition.html b/docs/interfaces/destinyplugsetdefinition.html new file mode 100644 index 0000000..a37a773 --- /dev/null +++ b/docs/interfaces/destinyplugsetdefinition.html @@ -0,0 +1,296 @@ + + + + + + DestinyPlugSetDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPlugSetDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Sometimes, we have large sets of reusable plugs that are defined identically and + thus can (and in some cases, are so large that they must) be shared across the + places where they are used. These are the definitions for those reusable sets of + plugs.

        +
        +

        See DestinyItemSocketEntryDefinition.plugSource and reusablePlugSetHash for the + relationship between these reusable plug sets and the sockets that leverage them + (for starters, Emotes).

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPlugSetDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        +

        If you want to show these plugs in isolation, these are the display properties + for them.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        reusablePlugItems

        + + +
        +
        +

        This is a list of pre-determined plugs that can be plugged into this socket, + without the character having the plug in their inventory.

        +
        +

        If this list is populated, you will not be allowed to plug an arbitrary item in + the socket: you will only be able to choose from one of these reusable plugs.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyplugsetscomponent.html b/docs/interfaces/destinyplugsetscomponent.html new file mode 100644 index 0000000..d439363 --- /dev/null +++ b/docs/interfaces/destinyplugsetscomponent.html @@ -0,0 +1,224 @@ + + + + + + DestinyPlugSetsComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPlugSetsComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Sockets may refer to a "Plug Set": a set of reusable plugs that may be shared + across multiple sockets (or even, in theory, multiple sockets over multiple + items).

        +
        +

        This is the set of those plugs that we came across in the users' inventory, + along with the values for plugs in the set. Any given set in this component may + be represented in Character and Profile-level, as some plugs may be Profile- + level restricted, and some character-level restricted. (note that the ones that + are even more specific will remain on the actual socket component itself, as + they cannot be reused)

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPlugSetsComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        plugs

        +
        plugs: object
        + +
        +
        +

        The shared list of plugs for each relevant PlugSet, keyed by the hash identifier + of the PlugSet (DestinyPlugSetDefinition).

        +
        +

        Mapped to DestinyPlugSetDefinition in the manifest.

        +
        +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyplugwhitelistentrydefinition.html b/docs/interfaces/destinyplugwhitelistentrydefinition.html new file mode 100644 index 0000000..9a82fe6 --- /dev/null +++ b/docs/interfaces/destinyplugwhitelistentrydefinition.html @@ -0,0 +1,262 @@ + + + + + + DestinyPlugWhitelistEntryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPlugWhitelistEntryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Defines a plug "Category" that is allowed to be plugged into a socket of this + type.

        +
        +

        This should be compared against a given plug item's + DestinyInventoryItemDefinition.plug.plugCategoryHash, which indicates the plug + item's category.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPlugWhitelistEntryDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        categoryHash

        +
        categoryHash: number
        + +
        +
        +

        The hash identifier of the Plug Category to compare against the plug item's plug. + plugCategoryHash.

        +
        +

        Note that this does NOT relate to any Definition in itself, it is only used for + comparison purposes.

        +
        +
        +
        + +

        categoryIdentifier

        +
        categoryIdentifier: string
        + +
        +
        +

        The string identifier for the category, which is here mostly for debug purposes.

        +
        +
        +
        +
        + +

        reinitializationPossiblePlugHashes

        +
        reinitializationPossiblePlugHashes: number[]
        + +
        +
        +

        The list of all plug items (DestinyInventoryItemDefinition) that the socket may + randomly be populated with when reinitialized.

        +
        +

        Which ones you should actually show are determined by the plug being inserted + into the socket, and the socket’s type.

        +

        When you inspect the plug that could go into a Masterwork Socket, look up the + socket type of the socket being inspected and find the + DestinySocketTypeDefinition.

        +

        Then, look at the Plugs that can fit in that socket. Find the Whitelist in the + DestinySocketTypeDefinition that matches the plug item’s categoryhash.

        +

        That whitelist entry will potentially have a new “ + reinitializationPossiblePlugHashes” property.If it does, that means we know what + it will roll if you try to insert this plug into this socket.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypositiondefinition.html b/docs/interfaces/destinypositiondefinition.html new file mode 100644 index 0000000..e388449 --- /dev/null +++ b/docs/interfaces/destinypositiondefinition.html @@ -0,0 +1,222 @@ + + + + + + DestinyPositionDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPositionDefinition

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPositionDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        +
          +
        • x
        • +
        • y
        • +
        • z
        • +
        +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        x

        +
        x: number
        + +
        +
        + +

        y

        +
        y: number
        + +
        +
        + +

        z

        +
        z: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypostgamecarnagereportdata.html b/docs/interfaces/destinypostgamecarnagereportdata.html new file mode 100644 index 0000000..f19f1b0 --- /dev/null +++ b/docs/interfaces/destinypostgamecarnagereportdata.html @@ -0,0 +1,276 @@ + + + + + + DestinyPostGameCarnageReportData | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPostGameCarnageReportData

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPostGameCarnageReportData +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activityDetails

        + + +
        +
        +

        Details about the activity.

        +
        +
        +
        +
        + +

        entries

        + + +
        +
        +

        Collection of players and their data for this activity.

        +
        +
        +
        +
        + +

        period

        +
        period: string
        + +
        +
        +

        Date and time for the activity.

        +
        +
        +
        +
        + +

        Optional startingPhaseIndex

        +
        startingPhaseIndex: number
        + +
        +
        +

        If this activity has "phases", this is the phase at which the activity was + started.

        +
        +
        +
        +
        + +

        teams

        + + +
        +
        +

        Collection of stats for the player in this activity.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypostgamecarnagereportentry.html b/docs/interfaces/destinypostgamecarnagereportentry.html new file mode 100644 index 0000000..d7aecfe --- /dev/null +++ b/docs/interfaces/destinypostgamecarnagereportentry.html @@ -0,0 +1,302 @@ + + + + + + DestinyPostGameCarnageReportEntry | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPostGameCarnageReportEntry

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPostGameCarnageReportEntry +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        characterId

        +
        characterId: string
        + +
        +
        +

        ID of the player's character used in the activity.

        +
        +
        +
        +
        + +

        extended

        + + +
        +
        +

        Extended data extracted from the activity blob.

        +
        +
        +
        +
        + +

        player

        + + +
        +
        +

        Identity details of the player

        +
        +
        +
        +
        + +

        score

        + + +
        +
        +

        Score of the player if available

        +
        +
        +
        +
        + +

        standing

        +
        standing: number
        + +
        +
        +

        Standing of the player

        +
        +
        +
        +
        + +

        values

        +
        values: object
        + +
        +
        +

        Collection of stats for the player in this activity.

        +
        +
        +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypostgamecarnagereportextendeddata.html b/docs/interfaces/destinypostgamecarnagereportextendeddata.html new file mode 100644 index 0000000..7c0f943 --- /dev/null +++ b/docs/interfaces/destinypostgamecarnagereportextendeddata.html @@ -0,0 +1,226 @@ + + + + + + DestinyPostGameCarnageReportExtendedData | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPostGameCarnageReportExtendedData

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPostGameCarnageReportExtendedData +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        values

        +
        values: object
        + +
        +
        +

        Collection of stats for the player in this activity.

        +
        +
        +
        +

        Type declaration

        + +
        +
        +
        + +

        weapons

        + + +
        +
        +

        List of weapons and their perspective values.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypostgamecarnagereportteamentry.html b/docs/interfaces/destinypostgamecarnagereportteamentry.html new file mode 100644 index 0000000..f834b1a --- /dev/null +++ b/docs/interfaces/destinypostgamecarnagereportteamentry.html @@ -0,0 +1,256 @@ + + + + + + DestinyPostGameCarnageReportTeamEntry | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPostGameCarnageReportTeamEntry

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPostGameCarnageReportTeamEntry +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        score

        + + +
        +
        +

        Score earned by the team

        +
        +
        +
        +
        + +

        standing

        + + +
        +
        +

        Team's standing relative to other teams.

        +
        +
        +
        +
        + +

        teamId

        +
        teamId: number
        + +
        +
        +

        Integer ID for the team.

        +
        +
        +
        +
        + +

        teamName

        +
        teamName: string
        + +
        +
        +

        Alpha or Bravo

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypostmastertransferrequest.html b/docs/interfaces/destinypostmastertransferrequest.html new file mode 100644 index 0000000..a8c51c2 --- /dev/null +++ b/docs/interfaces/destinypostmastertransferrequest.html @@ -0,0 +1,250 @@ + + + + + + DestinyPostmasterTransferRequest | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPostmasterTransferRequest

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPostmasterTransferRequest +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        characterId

        +
        characterId: string
        + +
        +
        + +

        itemId

        +
        itemId: string
        + +
        +
        + +

        itemReferenceHash

        +
        itemReferenceHash: number
        + +
        +
        + +

        membershipType

        +
        membershipType: BungieMembershipType
        + +
        +
        + +

        stackSize

        +
        stackSize: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypresentationchildblock.html b/docs/interfaces/destinypresentationchildblock.html new file mode 100644 index 0000000..3776942 --- /dev/null +++ b/docs/interfaces/destinypresentationchildblock.html @@ -0,0 +1,227 @@ + + + + + + DestinyPresentationChildBlock | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPresentationChildBlock

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPresentationChildBlock +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        displayStyle

        + + +
        +
        + +

        parentPresentationNodeHashes

        +
        parentPresentationNodeHashes: number[]
        + +
        +
        +

        Mapped to DestinyPresentationNodeDefinition in the manifest.

        +
        +
        +
        +
        + +

        presentationNodeType

        +
        presentationNodeType: DestinyPresentationNodeType
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypresentationnodechildentry.html b/docs/interfaces/destinypresentationnodechildentry.html new file mode 100644 index 0000000..053b29b --- /dev/null +++ b/docs/interfaces/destinypresentationnodechildentry.html @@ -0,0 +1,199 @@ + + + + + + DestinyPresentationNodeChildEntry | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPresentationNodeChildEntry

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPresentationNodeChildEntry +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        presentationNodeHash

        +
        presentationNodeHash: number
        + +
        +
        +

        Mapped to DestinyPresentationNodeDefinition in the manifest.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypresentationnodechildrenblock.html b/docs/interfaces/destinypresentationnodechildrenblock.html new file mode 100644 index 0000000..2393e53 --- /dev/null +++ b/docs/interfaces/destinypresentationnodechildrenblock.html @@ -0,0 +1,233 @@ + + + + + + DestinyPresentationNodeChildrenBlock | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPresentationNodeChildrenBlock

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        As/if presentation nodes begin to host more entities as children, these lists + will be added to. One list property exists per type of entity that can be + treated as a child of this presentation node, and each holds the identifier of + the entity and any associated information needed to display the UI for that + entity (if anything)

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPresentationNodeChildrenBlock +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        collectibles

        + + +
        +
        + +

        presentationNodes

        + + +
        +
        + +

        records

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypresentationnodecollectiblechildentry.html b/docs/interfaces/destinypresentationnodecollectiblechildentry.html new file mode 100644 index 0000000..e602805 --- /dev/null +++ b/docs/interfaces/destinypresentationnodecollectiblechildentry.html @@ -0,0 +1,199 @@ + + + + + + DestinyPresentationNodeCollectibleChildEntry | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPresentationNodeCollectibleChildEntry

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPresentationNodeCollectibleChildEntry +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        collectibleHash

        +
        collectibleHash: number
        + +
        +
        +

        Mapped to DestinyCollectibleDefinition in the manifest.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypresentationnodecomponent.html b/docs/interfaces/destinypresentationnodecomponent.html new file mode 100644 index 0000000..692783e --- /dev/null +++ b/docs/interfaces/destinypresentationnodecomponent.html @@ -0,0 +1,261 @@ + + + + + + DestinyPresentationNodeComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPresentationNodeComponent

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPresentationNodeComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        completionValue

        +
        completionValue: number
        + +
        +
        +

        The value at which the presentation ode is considered to be completed.

        +
        +
        +
        +
        + +

        objective

        + + +
        +
        +

        An optional property: presentation nodes MAY have objectives, which can be used + to infer more human readable data about the progress. However, progressValue and + completionValue ought to be considered the canonical values for progress on + Progression Nodes.

        +
        +
        +
        +
        + +

        progressValue

        +
        progressValue: number
        + +
        +
        +

        How much of the presentation node is considered to be completed so far by the + given character/profile.

        +
        +
        +
        +
        + +

        state

        + + +
        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypresentationnodedefinition.html b/docs/interfaces/destinypresentationnodedefinition.html new file mode 100644 index 0000000..0a9730b --- /dev/null +++ b/docs/interfaces/destinypresentationnodedefinition.html @@ -0,0 +1,514 @@ + + + + + + DestinyPresentationNodeDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPresentationNodeDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A PresentationNode is an entity that represents a logical grouping of other + entities visually/organizationally.

        +
        +

        For now, Presentation Nodes may contain the following... but it may be used for + more in the future:

        +
          +
        • Collectibles - Records (Or, as the public will call them, "Triumphs." Don't + ask me why we're overloading the term "Triumph", it still hurts me to think + about it) - Other Presentation Nodes, allowing a tree of Presentation Nodes to + be created
        • +
        +

        Part of me wants to break these into conceptual definitions per entity being + collected, but the possibility of these different types being mixed in the same + UI and the possibility that it could actually be more useful to return the "bare + metal" presentation node concept has resulted in me deciding against that for + the time being.

        +

        We'll see if I come to regret this as well.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPresentationNodeDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        children

        + + +
        +
        +

        The child entities contained by this presentation node.

        +
        +
        +
        +
        + +

        Optional completionRecordHash

        +
        completionRecordHash: number
        + +
        +
        +

        If this presentation node has an associated "Record" that you can accomplish for + completing its children, this is the identifier of that Record.

        +
        +

        Mapped to DestinyRecordDefinition in the manifest.

        +
        +
        +
        + +

        disableChildSubscreenNavigation

        +
        disableChildSubscreenNavigation: boolean
        + +
        +
        +

        If this presentation node has children, but the game doesn't let you inspect the + details of those children, that is indicated here.

        +
        +
        +
        +
        + +

        displayProperties

        + + +
        +
        + +

        displayStyle

        + + +
        +
        +

        A hint for how to display this presentation node when it's shown in a list.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        nodeType

        + + +
        +
        + +

        Optional objectiveHash

        +
        objectiveHash: number
        + +
        +
        +

        If this presentation node shows a related objective (for instance, if it tracks + the progress of its children), the objective being tracked is indicated here.

        +
        +

        Mapped to DestinyObjectiveDefinition in the manifest.

        +
        +
        +
        + +

        originalIcon

        +
        originalIcon: string
        + +
        +
        +

        The original icon for this presentation node, before we futzed with it.

        +
        +
        +
        +
        + +

        parentNodeHashes

        +
        parentNodeHashes: number[]
        + +
        +
        +

        A quick reference to presentation nodes that have this node as a child. ( + presentation nodes can be parented under multiple parents)

        +
        +

        Mapped to DestinyPresentationNodeDefinition in the manifest.

        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        requirements

        + + +
        +
        +

        The requirements for being able to interact with this presentation node and its + children.

        +
        +
        +
        +
        + +

        rootViewIcon

        +
        rootViewIcon: string
        + +
        +
        +

        Some presentation nodes are meant to be explicitly shown on the "root" or "entry" + screens for the feature to which they are related. You should use this icon + when showing them on such a view, if you have a similar "entry point" view in + your UI. If you don't have a UI, then I guess it doesn't matter either way does + it?

        +
        +
        +
        +
        + +

        scope

        + + +
        +
        +

        Indicates whether this presentation node's state is determined on a per- + character or on an account-wide basis.

        +
        +
        +
        +
        + +

        screenStyle

        + + +
        +
        +

        A hint for how to display this presentation node when it's shown in its own + detail screen.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypresentationnoderecordchildentry.html b/docs/interfaces/destinypresentationnoderecordchildentry.html new file mode 100644 index 0000000..99e1632 --- /dev/null +++ b/docs/interfaces/destinypresentationnoderecordchildentry.html @@ -0,0 +1,199 @@ + + + + + + DestinyPresentationNodeRecordChildEntry | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPresentationNodeRecordChildEntry

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPresentationNodeRecordChildEntry +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        recordHash

        +
        recordHash: number
        + +
        +
        +

        Mapped to DestinyRecordDefinition in the manifest.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypresentationnoderequirementsblock.html b/docs/interfaces/destinypresentationnoderequirementsblock.html new file mode 100644 index 0000000..da0c786 --- /dev/null +++ b/docs/interfaces/destinypresentationnoderequirementsblock.html @@ -0,0 +1,209 @@ + + + + + + DestinyPresentationNodeRequirementsBlock | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPresentationNodeRequirementsBlock

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Presentation nodes can be restricted by various requirements. This defines the + rules of those requirements, and the message(s) to be shown if these + requirements aren't met.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPresentationNodeRequirementsBlock +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        entitlementUnavailableMessage

        +
        entitlementUnavailableMessage: string
        + +
        +
        +

        If this node is not accessible due to Entitlements (for instance, you don't own + the required game expansion), this is the message to show.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypresentationnodescomponent.html b/docs/interfaces/destinypresentationnodescomponent.html new file mode 100644 index 0000000..e1b5e09 --- /dev/null +++ b/docs/interfaces/destinypresentationnodescomponent.html @@ -0,0 +1,202 @@ + + + + + + DestinyPresentationNodesComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPresentationNodesComponent

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPresentationNodesComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        nodes

        +
        nodes: object
        + +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyprofilecollectiblescomponent.html b/docs/interfaces/destinyprofilecollectiblescomponent.html new file mode 100644 index 0000000..c2c24c8 --- /dev/null +++ b/docs/interfaces/destinyprofilecollectiblescomponent.html @@ -0,0 +1,247 @@ + + + + + + DestinyProfileCollectiblesComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyProfileCollectiblesComponent

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyProfileCollectiblesComponent +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        collectibles

        +
        collectibles: object
        + +
        +

        Type declaration

        + +
        +
        +
        + +

        newnessFlaggedCollectibleHashes

        +
        newnessFlaggedCollectibleHashes: number[]
        + +
        +
        +

        The list of collectibles determined by the game as having been "recently" + acquired.

        +
        +

        The game client itself actually controls this data, so I personally question + whether anyone will get much use out of this: because we can't edit this value + through the API. But in case anyone finds it useful, here it is.

        +

        Mapped to DestinyCollectibleDefinition in the manifest.

        +
        +
        +
        + +

        recentCollectibleHashes

        +
        recentCollectibleHashes: number[]
        + +
        +
        +

        The list of collectibles determined by the game as having been "recently" + acquired.

        +
        +

        Mapped to DestinyCollectibleDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyprofilecomponent.html b/docs/interfaces/destinyprofilecomponent.html new file mode 100644 index 0000000..542f9d8 --- /dev/null +++ b/docs/interfaces/destinyprofilecomponent.html @@ -0,0 +1,267 @@ + + + + + + DestinyProfileComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyProfileComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The most essential summary information about a Profile (in Destiny 1, we called + these "Accounts").

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyProfileComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        characterIds

        +
        characterIds: string[]
        + +
        +
        +

        A list of the character IDs, for further querying on your part.

        +
        +
        +
        +
        + +

        dateLastPlayed

        +
        dateLastPlayed: string
        + +
        +
        +

        The last time the user played with any character on this Profile.

        +
        +
        +
        +
        + +

        userInfo

        +
        userInfo: UserInfoCard
        + +
        +
        +

        If you need to render the Profile (their platform name, icon, etc...) somewhere, + this property contains that information.

        +
        +
        +
        +
        + +

        versionsOwned

        +
        versionsOwned: DestinyGameVersions
        + +
        +
        +

        If you want to know what expansions they own, this will contain that data.

        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyprofileprogressioncomponent.html b/docs/interfaces/destinyprofileprogressioncomponent.html new file mode 100644 index 0000000..4fb0430 --- /dev/null +++ b/docs/interfaces/destinyprofileprogressioncomponent.html @@ -0,0 +1,227 @@ + + + + + + DestinyProfileProgressionComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyProfileProgressionComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The set of progression-related information that applies at a Profile-wide level + for your Destiny experience. This differs from the Jimi Hendrix Experience + because there's less guitars on fire. Yet. #spoileralert?

        +
        +

        This will include information such as Checklist info.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyProfileProgressionComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        checklists

        +
        checklists: object
        + +
        +
        +

        The set of checklists that can be examined on a profile-wide basis, keyed by the + hash identifier of the Checklist (DestinyChecklistDefinition)

        +
        +

        For each checklist returned, its value is itself a Dictionary keyed by the + checklist's hash identifier with the value being a boolean indicating if it's + been discovered yet.

        +

        Mapped to DestinyChecklistDefinition in the manifest.

        +
        +
        +

        Type declaration

        +
          +
        • +
          [key: number]: object
          +
            +
          • +
            [key: number]: boolean
            +
          • +
          +
        • +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyprofilerecordscomponent.html b/docs/interfaces/destinyprofilerecordscomponent.html new file mode 100644 index 0000000..d5a84ee --- /dev/null +++ b/docs/interfaces/destinyprofilerecordscomponent.html @@ -0,0 +1,242 @@ + + + + + + DestinyProfileRecordsComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyProfileRecordsComponent

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyProfileRecordsComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        records

        +
        records: object
        + +
        +

        Type declaration

        + +
        +
        +
        + +

        score

        +
        score: number
        + +
        +
        +

        Your "Triumphs" score.

        +
        +
        +
        +
        + +

        Optional trackedRecordHash

        +
        trackedRecordHash: number
        + +
        +
        +

        If this profile is tracking a record, this is the hash identifier of the record + it is tracking.

        +
        +

        Mapped to DestinyRecordDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyprofileresponse.html b/docs/interfaces/destinyprofileresponse.html new file mode 100644 index 0000000..16996d9 --- /dev/null +++ b/docs/interfaces/destinyprofileresponse.html @@ -0,0 +1,719 @@ + + + + + + DestinyProfileResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyProfileResponse

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The response for GetDestinyProfile, with components for character and item-level + data.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyProfileResponse +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        characterActivities

        + + +
        +
        +

        Character activity data - the activities available to this character and its + status, keyed by the Character's Id.

        +
        +

        COMPONENT TYPE: CharacterActivities

        +
        +
        +
        + +

        characterCollectibles

        + + +
        +
        +

        COMPONENT TYPE: Collectibles

        +
        +
        +
        +
        + +

        characterCurrencyLookups

        + + +
        +
        +

        A "lookup" convenience component that can be used to quickly check if the + character has access to items that can be used for purchasing.

        +
        +

        COMPONENT TYPE: CurrencyLookups

        +
        +
        +
        + +

        characterEquipment

        + + +
        +
        +

        The character's equipped items, keyed by the Character's Id.

        +
        +

        COMPONENT TYPE: CharacterEquipment

        +
        +
        +
        + +

        characterInventories

        + + +
        +
        +

        The character-level non-equipped inventory items, keyed by the Character's Id.

        +
        +

        COMPONENT TYPE: CharacterInventories

        +
        +
        +
        + +

        characterKiosks

        + + +
        +
        +

        Items available from Kiosks that are available to a specific character as + opposed to the account as a whole. It must be combined with data from the + profileKiosks property to get a full picture of the character's available items + to check out of a kiosk.

        +
        +

        This component returns information about what Kiosk items are available to you + on a Character level. Usually, kiosk items will be earned for the entire + Profile (all characters) at once. To find those, look in the profileKiosks + property.

        +

        COMPONENT TYPE: Kiosks

        +
        +
        +
        + +

        characterPlugSets

        + + +
        +
        +

        When sockets refer to reusable Plug Sets (see DestinyPlugSetDefinition for more + info), this is the set of plugs and their states, per character, that are + character-scoped.

        +
        +

        This comes back with ItemSockets, as it is needed for a complete picture of the + sockets on requested items.

        +

        COMPONENT TYPE: ItemSockets

        +
        +
        +
        + +

        characterPresentationNodes

        + + +
        +
        +

        COMPONENT TYPE: PresentationNodes

        +
        +
        +
        +
        + +

        characterProgressions

        + + +
        +
        +

        Character-level progression data, keyed by the Character's Id.

        +
        +

        COMPONENT TYPE: CharacterProgressions

        +
        +
        +
        + +

        characterRecords

        + + +
        +
        +

        COMPONENT TYPE: Records

        +
        +
        +
        +
        + +

        characterRenderData

        + + +
        +
        +

        Character rendering data - a minimal set of info needed to render a character in + 3D - keyed by the Character's Id.

        +
        +

        COMPONENT TYPE: CharacterRenderData

        +
        +
        +
        + +

        characterUninstancedItemComponents

        +
        characterUninstancedItemComponents: object
        + +
        +
        +

        Do you ever get the feeling that a system was designed too flexibly? That it + can be used in so many different ways that you end up being unable to provide an + easy to use abstraction for the mess that's happening under the surface?

        +
        +

        Let's talk about character-specific data that might be related to items without + instances. These two statements are totally unrelated, I promise.

        +

        At some point during D2, it was decided that items - such as Bounties - could be + given to characters and not have instance data, but that could display and + even use relevant state information on your account and character.

        +

        Up to now, any item that had meaningful dependencies on character or account + state had to be instanced, and thus "itemComponents" was all that you needed: it + was keyed by item's instance IDs and provided the stateful information you + needed inside.

        +

        Unfortunately, we don't live in such a magical world anymore. This is + information held on a per-character basis about non-instanced items that the + characters have in their inventory - or that reference character-specific state + information even if it's in Account-level inventory - and the values related to + that item's state in relation to the given character.

        +

        To give a concrete example, look at a Moments of Triumph bounty. They exist in a + character's inventory, and show/care about a character's progression toward + completing the bounty. But the bounty itself is a non-instanced item, like a mod + or a currency. This returns that data for the characters who have the bounty in + their inventory.

        +

        I'm not crying, you're crying Okay we're both crying but it's going to be okay I + promise Actually I shouldn't promise that, I don't know if it's going to be okay

        +
        +
        +

        Type declaration

        + +
        +
        +
        + +

        characters

        + + +
        +
        +

        Basic information about each character, keyed by the CharacterId.

        +
        +

        COMPONENT TYPE: Characters

        +
        +
        +
        + +

        itemComponents

        + + +
        +
        +

        Information about instanced items across all returned characters, keyed by the + item's instance ID.

        +
        +

        COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component + types.]

        +
        +
        +
        + +

        profile

        + + +
        +
        +

        The basic information about the Destiny Profile (formerly "Account").

        +
        +

        COMPONENT TYPE: Profiles

        +
        +
        +
        + +

        profileCollectibles

        + + +
        +
        +

        COMPONENT TYPE: Collectibles

        +
        +
        +
        +
        + +

        profileCurrencies

        + + +
        +
        +

        The profile-level currencies owned by the Destiny Profile.

        +
        +

        COMPONENT TYPE: ProfileCurrencies

        +
        +
        +
        + +

        profileInventory

        + + +
        +
        +

        The profile-level inventory of the Destiny Profile.

        +
        +

        COMPONENT TYPE: ProfileInventories

        +
        +
        +
        + +

        profileKiosks

        + + +
        +
        +

        Items available from Kiosks that are available Profile-wide (i.e. across all + characters)

        +
        +

        This component returns information about what Kiosk items are available to you + on a Profile level. It is theoretically possible for Kiosks to have items + gated by specific Character as well. If you ever have those, you will find them + on the characterKiosks property.

        +

        COMPONENT TYPE: Kiosks

        +
        +
        +
        + +

        profilePlugSets

        + + +
        +
        +

        When sockets refer to reusable Plug Sets (see DestinyPlugSetDefinition for more + info), this is the set of plugs and their states that are profile-scoped.

        +
        +

        This comes back with ItemSockets, as it is needed for a complete picture of the + sockets on requested items.

        +

        COMPONENT TYPE: ItemSockets

        +
        +
        +
        + +

        profilePresentationNodes

        + + +
        +
        +

        COMPONENT TYPE: PresentationNodes

        +
        +
        +
        +
        + +

        profileProgression

        + + +
        +
        +

        When we have progression information - such as Checklists - that may apply + profile-wide, it will be returned here rather than in the per-character + progression data.

        +
        +

        COMPONENT TYPE: ProfileProgression

        +
        +
        +
        + +

        profileRecords

        + + +
        +
        +

        COMPONENT TYPE: Records

        +
        +
        +
        +
        + +

        vendorReceipts

        + + +
        +
        +

        Recent, refundable purchases you have made from vendors. When will you use it? + Couldn't say...

        +
        +

        COMPONENT TYPE: VendorReceipts

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyprofileuserinfocard.html b/docs/interfaces/destinyprofileuserinfocard.html new file mode 100644 index 0000000..11663f2 --- /dev/null +++ b/docs/interfaces/destinyprofileuserinfocard.html @@ -0,0 +1,291 @@ + + + + + + DestinyProfileUserInfoCard | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyProfileUserInfoCard

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyProfileUserInfoCard +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        dateLastPlayed

        +
        dateLastPlayed: string
        + +
        +
        + +

        displayName

        +
        displayName: string
        + +
        +
        +

        Display Name the player has chosen for themselves. The display name is optional + when the data type is used as input to a platform API.

        +
        +
        +
        +
        + +

        iconPath

        +
        iconPath: string
        + +
        +
        +

        URL the Icon if available.

        +
        +
        +
        +
        + +

        membershipId

        +
        membershipId: string
        + +
        +
        +

        Membership ID as they user is known in the Accounts service

        +
        +
        +
        +
        + +

        membershipType

        +
        membershipType: BungieMembershipType
        + +
        +
        +

        Type of the membership.

        +
        +
        +
        +
        + +

        supplementalDisplayName

        +
        supplementalDisplayName: string
        + +
        +
        +

        A platform specific additional display name - ex: psn Real Name, bnet Unique + Name, etc.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyprogression.html b/docs/interfaces/destinyprogression.html new file mode 100644 index 0000000..ad6f3b1 --- /dev/null +++ b/docs/interfaces/destinyprogression.html @@ -0,0 +1,410 @@ + + + + + + DestinyProgression | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyProgression

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Information about a current character's status with a Progression. A progression + is a value that can increase with activity and has levels. Think Character Level + and Reputation Levels. Combine this "live" data with the related + DestinyProgressionDefinition for a full picture of the Progression.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyProgression +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        currentProgress

        +
        currentProgress: number
        + +
        +
        +

        This is the total amount of progress obtained overall for this progression (for + instance, the total amount of Character Level experience earned)

        +
        +
        +
        +
        + +

        dailyLimit

        +
        dailyLimit: number
        + +
        +
        +

        If this progression has a daily limit, this is that limit.

        +
        +
        +
        +
        + +

        dailyProgress

        +
        dailyProgress: number
        + +
        +
        +

        The amount of progress earned today for this progression.

        +
        +
        +
        +
        + +

        level

        +
        level: number
        + +
        +
        +

        This is the level of the progression (for instance, the Character Level).

        +
        +
        +
        +
        + +

        levelCap

        +
        levelCap: number
        + +
        +
        +

        This is the maximum possible level you can achieve for this progression (for + example, the maximum character level obtainable)

        +
        +
        +
        +
        + +

        nextLevelAt

        +
        nextLevelAt: number
        + +
        +
        +

        The total amount of progression (i.e. "Experience") needed in order to reach the + next level.

        +
        +
        +
        +
        + +

        progressToNextLevel

        +
        progressToNextLevel: number
        + +
        +
        +

        The amount of progression (i.e. "Experience") needed to reach the next level of + this Progression. Jeez, progression is such an overloaded word.

        +
        +
        +
        +
        + +

        progressionHash

        +
        progressionHash: number
        + +
        +
        +

        The hash identifier of the Progression in question. Use it to look up the + DestinyProgressionDefinition in static data.

        +
        +

        Mapped to DestinyProgressionDefinition in the manifest.

        +
        +
        +
        + +

        stepIndex

        +
        stepIndex: number
        + +
        +
        +

        Progressions define their levels in "steps". Since the last step may be + repeatable, the user may be at a higher level than the actual Step achieved in + the progression. Not necessarily useful, but potentially interesting for those + cruising the API. Relate this to the "steps" property of the DestinyProgression + to see which step the user is on, if you care about that. (Note that this is + Content Version dependent since it refers to indexes.)

        +
        +
        +
        +
        + +

        weeklyLimit

        +
        weeklyLimit: number
        + +
        +
        +

        If this progression has a weekly limit, this is that limit.

        +
        +
        +
        +
        + +

        weeklyProgress

        +
        weeklyProgress: number
        + +
        +
        +

        The amount of progress earned toward this progression in the current week.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyprogressiondefinition.html b/docs/interfaces/destinyprogressiondefinition.html new file mode 100644 index 0000000..fc7ce1d --- /dev/null +++ b/docs/interfaces/destinyprogressiondefinition.html @@ -0,0 +1,451 @@ + + + + + + DestinyProgressionDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyProgressionDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A "Progression" in Destiny is best explained by an example.

        +
        +

        A Character's "Level" is a progression: it has Experience that can be earned, + levels that can be gained, and is evaluated and displayed at various points in + the game. A Character's "Faction Reputation" is also a progression for much the + same reason.

        +

        Progression is used by a variety of systems, and the definition of a Progression + will generally only be useful if combining with live data (such as a character's + DestinyCharacterProgressionComponent.progressions property, which holds that + character's live Progression states).

        +

        Fundamentally, a Progression measures your "Level" by evaluating the thresholds + in its Steps (one step per level, except for the last step which can be repeated + indefinitely for "Levels" that have no ceiling) against the total earned " + progression points"/experience. (for simplicity purposes, we will henceforth + refer to earned progression points as experience, though it need not be a + mechanic that in any way resembles Experience in a traditional sense).

        +

        Earned experience is calculated in a variety of ways, determined by the + Progression's scope. These go from looking up a stored value to performing + exceedingly obtuse calculations. This is why we provide live data in + DestinyCharacterProgressionComponent.progressions, so you don't have to worry + about those.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyProgressionDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        color

        + + +
        +
        +

        The #RGB string value for the color related to this progression, if there is one.

        +
        +
        +
        +
        + +

        displayProperties

        + + +
        +
        + +

        Optional factionHash

        +
        factionHash: number
        + +
        +
        +

        If the value exists, this is the hash identifier for the Faction that owns this + Progression.

        +
        +

        This is purely for convenience, if you're looking at a progression and want to + know if and who it's related to in terms of Faction Reputation.

        +

        Mapped to DestinyFactionDefinition in the manifest.

        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        rankIcon

        +
        rankIcon: string
        + +
        +
        +

        For progressions that have it, this is the rank icon we use in the Companion, + displayed above the progressions' rank value.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        repeatLastStep

        +
        repeatLastStep: boolean
        + +
        +
        +

        If this is True, then the progression doesn't have a maximum level.

        +
        +
        +
        +
        + +

        scope

        + + +
        +
        +

        The "Scope" of the progression indicates the source of the progression's live + data.

        +
        +

        See the DestinyProgressionScope enum for more info: but essentially, a + Progression can either be backed by a stored value, or it can be a calculated + derivative of other values.

        +
        +
        +
        + +

        source

        +
        source: string
        + +
        +
        +

        If there's a description of how to earn this progression in the local config, + this will be that localized description.

        +
        +
        +
        +
        + +

        steps

        + + +
        +
        +

        Progressions are divided into Steps, which roughly equate to "Levels" in the + traditional sense of a Progression. Notably, the last step can be repeated + indefinitely if repeatLastStep is true, meaning that the calculation for your + level is not as simple as comparing your current progress to the max progress of + the steps.

        +
        +

        These and more calculations are done for you if you grab live character + progression data, such as in the DestinyCharacterProgressionComponent.

        +
        +
        +
        + +

        visible

        +
        visible: boolean
        + +
        +
        +

        If true, the Progression is something worth showing to users.

        +
        +

        If false, BNet isn't going to show it. But that doesn't mean you can't. We're + all friends here.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyprogressiondisplaypropertiesdefinition.html b/docs/interfaces/destinyprogressiondisplaypropertiesdefinition.html new file mode 100644 index 0000000..fda4f6c --- /dev/null +++ b/docs/interfaces/destinyprogressiondisplaypropertiesdefinition.html @@ -0,0 +1,267 @@ + + + + + + DestinyProgressionDisplayPropertiesDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyProgressionDisplayPropertiesDefinition

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyProgressionDisplayPropertiesDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        description

        +
        description: string
        + +
        +
        + +

        displayUnitsName

        +
        displayUnitsName: string
        + +
        +
        +

        When progressions show your "experience" gained, that bar has units (i.e. " + Experience", "Bad Dudes Snuffed Out", whatever). This is the localized string + for that unit of measurement.

        +
        +
        +
        +
        + +

        hasIcon

        +
        hasIcon: boolean
        + +
        +
        + +

        icon

        +
        icon: string
        + +
        +
        +

        Note that "icon" is sometimes misleading, and should be interpreted in the + context of the entity. For instance, in Destiny 1 the + DestinyRecordBookDefinition's icon was a big picture of a book.

        +
        +

        But usually, it will be a small square image that you can use as... well, an + icon.

        +

        They are currently represented as 96px x 96px images.

        +
        +
        +
        + +

        name

        +
        name: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyprogressionlevelrequirementdefinition.html b/docs/interfaces/destinyprogressionlevelrequirementdefinition.html new file mode 100644 index 0000000..7321588 --- /dev/null +++ b/docs/interfaces/destinyprogressionlevelrequirementdefinition.html @@ -0,0 +1,301 @@ + + + + + + DestinyProgressionLevelRequirementDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyProgressionLevelRequirementDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        These are pre-constructed collections of data that can be used to determine the + Level Requirement for an item given a Progression to be tested (such as the + Character's level).

        +
        +

        For instance, say a character receives a new Auto Rifle, and that Auto Rifle's + DestinyInventoryItemDefinition.quality.progressionLevelRequirementHash property + is pointing at one of these DestinyProgressionLevelRequirementDefinitions. Let's + pretend also that the progressionHash it is pointing at is the Character Level + progression. In that situation, the character's level will be used to + interpolate a value in the requirementCurve property. The value picked up from + that interpolation will be the required level for the item.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyProgressionLevelRequirementDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        progressionHash

        +
        progressionHash: number
        + +
        +
        +

        The progression whose level should be used to determine the level requirement.

        +
        +

        Look up the DestinyProgressionDefinition with this hash for more information + about the progression in question.

        +

        Mapped to DestinyProgressionDefinition in the manifest.

        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        requirementCurve

        +
        requirementCurve: InterpolationPointFloat[]
        + +
        +
        +

        A curve of level requirements, weighted by the related progressions' level.

        +
        +

        Interpolate against this curve with the character's progression level to + determine what the level requirement of the generated item that is using this + data will be.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyprogressionmappingdefinition.html b/docs/interfaces/destinyprogressionmappingdefinition.html new file mode 100644 index 0000000..ccf5a63 --- /dev/null +++ b/docs/interfaces/destinyprogressionmappingdefinition.html @@ -0,0 +1,291 @@ + + + + + + DestinyProgressionMappingDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyProgressionMappingDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Aggregations of multiple progressions.

        +
        +

        These are used to apply rewards to multiple progressions at once. They can + sometimes have human readable data as well, but only extremely sporadically.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyProgressionMappingDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        +

        Infrequently defined in practice. Defer to the individual progressions' display + properties.

        +
        +
        +
        +
        + +

        displayUnits

        +
        displayUnits: string
        + +
        +
        +

        The localized unit of measurement for progression across the progressions + defined in this mapping. Unfortunately, this is very infrequently defined. Defer + to the individual progressions' display units.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyprogressionrewarddefinition.html b/docs/interfaces/destinyprogressionrewarddefinition.html new file mode 100644 index 0000000..7a80ee5 --- /dev/null +++ b/docs/interfaces/destinyprogressionrewarddefinition.html @@ -0,0 +1,252 @@ + + + + + + DestinyProgressionRewardDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyProgressionRewardDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Inventory Items can reward progression when actions are performed on them. A + common example of this in Destiny 1 was Bounties, which would reward Experience + on your Character and the like when you completed the bounty.

        +
        +

        Note that this maps to a DestinyProgressionMappingDefinition, and not a + DestinyProgressionDefinition directly. This is apparently so that multiple + progressions can be granted progression points/experience at the same time.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyProgressionRewardDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        amount

        +
        amount: number
        + +
        +
        +

        The amount of experience to give to each of the mapped progressions.

        +
        +
        +
        +
        + +

        applyThrottles

        +
        applyThrottles: boolean
        + +
        +
        +

        If true, the game's internal mechanisms to throttle progression should be + applied.

        +
        +
        +
        +
        + +

        progressionMappingHash

        +
        progressionMappingHash: number
        + +
        +
        +

        The hash identifier of the DestinyProgressionMappingDefinition that contains the + progressions for which experience should be applied.

        +
        +

        Mapped to DestinyProgressionMappingDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyprogressionstepdefinition.html b/docs/interfaces/destinyprogressionstepdefinition.html new file mode 100644 index 0000000..cff788d --- /dev/null +++ b/docs/interfaces/destinyprogressionstepdefinition.html @@ -0,0 +1,291 @@ + + + + + + DestinyProgressionStepDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyProgressionStepDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This defines a single Step in a progression (which roughly equates to a level. + See DestinyProgressionDefinition for caveats).

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyProgressionStepDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayEffectType

        + + +
        +
        +

        This appears to be, when you "level up", whether a visual effect will display + and on what entity. See DestinyProgressionStepDisplayEffect for slightly more + info.

        +
        +
        +
        +
        + +

        icon

        +
        icon: string
        + +
        +
        +

        If this progression step has a specific icon related to it, this is the icon to + show.

        +
        +
        +
        +
        + +

        progressTotal

        +
        progressTotal: number
        + +
        +
        +

        The total amount of progression points/"experience" you will need to initially + reach this step. If this is the last step and the progression is repeating + indefinitely (DestinyProgressionDefinition.repeatLastStep), this will also be + the progress needed to level it up further by repeating this step again.

        +
        +
        +
        +
        + +

        rewardItems

        +
        rewardItems: DestinyItemQuantity[]
        + +
        +
        +

        A listing of items rewarded as a result of reaching this level.

        +
        +
        +
        +
        + +

        stepName

        +
        stepName: string
        + +
        +
        +

        Very rarely, Progressions will have localized text describing the Level of the + progression. This will be that localized text, if it exists. Otherwise, the + standard appears to be to simply show the level numerically.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypublicactivitystatus.html b/docs/interfaces/destinypublicactivitystatus.html new file mode 100644 index 0000000..1c13307 --- /dev/null +++ b/docs/interfaces/destinypublicactivitystatus.html @@ -0,0 +1,256 @@ + + + + + + DestinyPublicActivityStatus | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPublicActivityStatus

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents the public-facing status of an activity: any data about what is + currently active in the Activity, regardless of an individual character's + progress in it.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPublicActivityStatus +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        challengeObjectiveHashes

        +
        challengeObjectiveHashes: number[]
        + +
        +
        +

        Active Challenges for the activity, if any - represented as hashes for + DestinyObjectiveDefinitions.

        +
        +

        Mapped to DestinyObjectiveDefinition in the manifest.

        +
        +
        +
        + +

        modifierHashes

        +
        modifierHashes: number[]
        + +
        +
        +

        The active modifiers on this activity, if any - represented as hashes for + DestinyActivityModifierDefinitions.

        +
        +

        Mapped to DestinyActivityModifierDefinition in the manifest.

        +
        +
        +
        + +

        rewardTooltipItems

        +
        rewardTooltipItems: DestinyItemQuantity[]
        + +
        +
        +

        If the activity itself provides any specific "mock" rewards, this will be the + items and their quantity.

        +
        +

        Why "mock", you ask? Because these are the rewards as they are represented in + the tooltip of the Activity.

        +

        These are often pointers to fake items that look good in a tooltip, but + represent an abstract concept of what you will get for a reward rather than the + specific items you may obtain.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypublicmilestone.html b/docs/interfaces/destinypublicmilestone.html new file mode 100644 index 0000000..87f304f --- /dev/null +++ b/docs/interfaces/destinypublicmilestone.html @@ -0,0 +1,346 @@ + + + + + + DestinyPublicMilestone | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPublicMilestone

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Information about milestones, presented in a character state-agnostic manner. + Combine this data with DestinyMilestoneDefinition to get a full picture of the + milestone, which is basically a checklist of things to do in the game. Think of + this as GetPublicAdvisors 3.0, for those who used the Destiny 1 API.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPublicMilestone +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activities

        + + +
        +
        + +

        availableQuests

        +
        availableQuests: DestinyPublicMilestoneQuest[]
        + +
        +
        +

        A milestone not need have even a single quest, but if there are active quests + they will be returned here.

        +
        +
        +
        +
        + +

        Optional endDate

        +
        endDate: string
        + +
        +
        +

        If known, this is the date when the Milestone will expire/recycle/end.

        +
        +
        +
        +
        + +

        milestoneHash

        +
        milestoneHash: number
        + +
        +
        +

        The hash identifier for the milestone. Use it to look up the + DestinyMilestoneDefinition for static data about the Milestone.

        +
        +

        Mapped to DestinyMilestoneDefinition in the manifest.

        +
        +
        +
        + +

        order

        +
        order: number
        + +
        +
        +

        Used for ordering milestones in a display to match how we order them in BNet. + May pull from static data, or possibly in the future from dynamic information.

        +
        +
        +
        +
        + +

        Optional startDate

        +
        startDate: string
        + +
        +
        +

        If known, this is the date when the Milestone started/became active.

        +
        +
        +
        +
        + +

        vendorHashes

        +
        vendorHashes: number[]
        + +
        +
        +

        Sometimes milestones - or activities active in milestones - will have relevant + vendors. These are the vendors that are currently relevant.

        +
        +

        Deprecated, already, for the sake of the new "vendors" property that has more + data. What was I thinking.

        +
        +
        +
        + +

        vendors

        + + +
        +
        +

        This is why we can't have nice things. This is the ordered list of vendors to be + shown that relate to this milestone, potentially along with other interesting + data.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypublicmilestoneactivity.html b/docs/interfaces/destinypublicmilestoneactivity.html new file mode 100644 index 0000000..c7ac40e --- /dev/null +++ b/docs/interfaces/destinypublicmilestoneactivity.html @@ -0,0 +1,300 @@ + + + + + + DestinyPublicMilestoneActivity | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPublicMilestoneActivity

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A milestone may have one or more conceptual Activities associated with it, and + each of those conceptual activities could have a variety of variants, modes, + tiers, what-have-you. Our attempts to determine what qualifies as a conceptual + activity are, unfortunately, janky. So if you see missing modes or modes that + don't seem appropriate to you, let us know and I'll buy you a beer if we ever + meet up in person.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPublicMilestoneActivity +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activityHash

        +
        activityHash: number
        + +
        +
        +

        The hash identifier of the activity that's been chosen to be considered the + canonical "conceptual" activity definition. This may have many variants, defined + herein.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        Optional activityModeHash

        +
        activityModeHash: number
        + +
        +
        +

        The hash identifier of the most specific Activity Mode under which this activity + is played. This is useful for situations where the activity in question is - for + instance - a PVP map, but it's not clear what mode the PVP map is being played + under. If it's a playlist, this will be less specific: but hopefully useful in + some way.

        +
        +

        Mapped to DestinyActivityModeDefinition in the manifest.

        +
        +
        +
        + +

        Optional activityModeType

        +
        activityModeType: number
        + +
        +
        +

        The enumeration equivalent of the most specific Activity Mode under which this + activity is played.

        +
        +
        +
        +
        + +

        modifierHashes

        +
        modifierHashes: number[]
        + +
        +
        +

        The activity may have 0-to-many modifiers: if it does, this will contain the + hashes to the DestinyActivityModifierDefinition that defines the modifier being + applied.

        +
        +

        Mapped to DestinyActivityModifierDefinition in the manifest.

        +
        +
        +
        + +

        variants

        + + +
        +
        +

        Every relevant variation of this conceptual activity, including the conceptual + activity itself, have variants defined here.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypublicmilestoneactivityvariant.html b/docs/interfaces/destinypublicmilestoneactivityvariant.html new file mode 100644 index 0000000..7a39d32 --- /dev/null +++ b/docs/interfaces/destinypublicmilestoneactivityvariant.html @@ -0,0 +1,253 @@ + + + + + + DestinyPublicMilestoneActivityVariant | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPublicMilestoneActivityVariant

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents a variant of an activity that's relevant to a milestone.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPublicMilestoneActivityVariant +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activityHash

        +
        activityHash: number
        + +
        +
        +

        The hash identifier of this activity variant. Examine the activity's definition + in the Manifest database to determine what makes it a distinct variant. Usually + it will be difficulty level or whether or not it is a guided game variant of the + activity, but theoretically it could be distinguished in any arbitrary way.

        +
        +
        +
        +
        + +

        Optional activityModeHash

        +
        activityModeHash: number
        + +
        +
        +

        The hash identifier of the most specific Activity Mode under which this activity + is played. This is useful for situations where the activity in question is - for + instance - a PVP map, but it's not clear what mode the PVP map is being played + under. If it's a playlist, this will be less specific: but hopefully useful in + some way.

        +
        +

        Mapped to DestinyActivityModeDefinition in the manifest.

        +
        +
        +
        + +

        Optional activityModeType

        +
        activityModeType: number
        + +
        +
        +

        The enumeration equivalent of the most specific Activity Mode under which this + activity is played.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypublicmilestonechallenge.html b/docs/interfaces/destinypublicmilestonechallenge.html new file mode 100644 index 0000000..d6f0846 --- /dev/null +++ b/docs/interfaces/destinypublicmilestonechallenge.html @@ -0,0 +1,232 @@ + + + + + + DestinyPublicMilestoneChallenge | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPublicMilestoneChallenge

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A Milestone can have many Challenges. Challenges are just extra Objectives that + provide a fun way to mix-up play and provide extra rewards.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPublicMilestoneChallenge +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        Optional activityHash

        +
        activityHash: number
        + +
        +
        +

        IF the Objective is related to a specific Activity, this will be that activity's + hash. Use it to look up the DestinyActivityDefinition for additional data to + show.

        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        + +

        objectiveHash

        +
        objectiveHash: number
        + +
        +
        +

        The objective for the Challenge, which should have human-readable data about + what needs to be done to accomplish the objective. Use this hash to look up the + DestinyObjectiveDefinition.

        +
        +

        Mapped to DestinyObjectiveDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypublicmilestonechallengeactivity.html b/docs/interfaces/destinypublicmilestonechallengeactivity.html new file mode 100644 index 0000000..733399a --- /dev/null +++ b/docs/interfaces/destinypublicmilestonechallengeactivity.html @@ -0,0 +1,316 @@ + + + + + + DestinyPublicMilestoneChallengeActivity | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPublicMilestoneChallengeActivity

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPublicMilestoneChallengeActivity +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activityHash

        +
        activityHash: number
        + +
        +
        +

        Mapped to DestinyActivityDefinition in the manifest.

        +
        +
        +
        +
        + +

        booleanActivityOptions

        +
        booleanActivityOptions: object
        + +
        +
        +

        The set of activity options for this activity, keyed by an identifier that's + unique for this activity (not guaranteed to be unique between or across all + activities, though should be unique for every variant of a given conceptual + activity: for instance, the original D2 Raid has many variant + DestinyActivityDefinitions. While other activities could potentially have the + same option hashes, for any given D2 base Raid variant the hash will be unique).

        +
        +

        As a concrete example of this data, the hashes you get for Raids will correspond + to the currently active "Challenge Mode".

        +

        We have no human readable information for this data, so it's up to you if you + want to associate it with such info to show it.

        +
        +
        +

        Type declaration

        +
          +
        • +
          [key: number]: boolean
          +
        • +
        +
        +
        +
        + +

        challengeObjectiveHashes

        +
        challengeObjectiveHashes: number[]
        + +
        +
        + +

        Optional loadoutRequirementIndex

        +
        loadoutRequirementIndex: number
        + +
        +
        +

        If returned, this is the index into the DestinyActivityDefinition's "loadouts" + property, indicating the currently active loadout requirements.

        +
        +
        +
        +
        + +

        modifierHashes

        +
        modifierHashes: number[]
        + +
        +
        +

        If the activity has modifiers, this will be the list of modifiers that all + variants have in common. Perform lookups against + DestinyActivityModifierDefinition which defines the modifier being applied to + get at the modifier data.

        +
        +

        Note that, in the DestiyActivityDefinition, you will see many more modifiers + than this being referred to: those are all possible modifiers for the activity, + not the active ones. Use only the active ones to match what's really live.

        +

        Mapped to DestinyActivityModifierDefinition in the manifest.

        +
        +
        +
        + +

        phaseHashes

        +
        phaseHashes: number[]
        + +
        +
        +

        The ordered list of phases for this activity, if any. Note that we have no human + readable info for phases, nor any entities to relate them to: relating these + hashes to something human readable is up to you unfortunately.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypublicmilestonequest.html b/docs/interfaces/destinypublicmilestonequest.html new file mode 100644 index 0000000..11b0a76 --- /dev/null +++ b/docs/interfaces/destinypublicmilestonequest.html @@ -0,0 +1,246 @@ + + + + + + DestinyPublicMilestoneQuest | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPublicMilestoneQuest

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPublicMilestoneQuest +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activity

        + + +
        +
        +

        A milestone need not have an active activity, but if there is one it will be + returned here, along with any variant and additional information.

        +
        +
        +
        +
        + +

        challenges

        + + +
        +
        +

        For the given quest there could be 0-to-Many challenges: mini quests that you + can perform in the course of doing this quest, that may grant you rewards and + benefits.

        +
        +
        +
        +
        + +

        questItemHash

        +
        questItemHash: number
        + +
        +
        +

        Quests are defined as Items in content. As such, this is the hash identifier of + the DestinyInventoryItemDefinition that represents this quest. It will have + pointers to all of the steps in the quest, and display information for the quest + (title, description, icon etc) Individual steps will be referred to in the Quest + item's DestinyInventoryItemDefinition.setData property, and themselves are Items + with their own renderable data.

        +
        +

        Mapped to DestinyMilestoneDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypublicmilestonevendor.html b/docs/interfaces/destinypublicmilestonevendor.html new file mode 100644 index 0000000..8d46238 --- /dev/null +++ b/docs/interfaces/destinypublicmilestonevendor.html @@ -0,0 +1,225 @@ + + + + + + DestinyPublicMilestoneVendor | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPublicMilestoneVendor

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPublicMilestoneVendor +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        Optional previewItemHash

        +
        previewItemHash: number
        + +
        +
        +

        If this vendor is featuring a specific item for this event, this will be the + hash identifier of that item. I'm taking bets now on how long we go before this + needs to be a list or some other, more complex representation instead and I + deprecate this too. I'm going to go with 5 months. Calling it now, 2017-09-14 at + 9:46pm PST.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        vendorHash

        +
        vendorHash: number
        + +
        +
        +

        The hash identifier of the Vendor related to this Milestone. You can show useful + things from this, such as thier Faction icon or whatever you might care about.

        +
        +

        Mapped to DestinyVendorDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypublicvendorcomponent.html b/docs/interfaces/destinypublicvendorcomponent.html new file mode 100644 index 0000000..0cc2251 --- /dev/null +++ b/docs/interfaces/destinypublicvendorcomponent.html @@ -0,0 +1,256 @@ + + + + + + DestinyPublicVendorComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPublicVendorComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This component contains essential/summary information about the vendor from the + perspective of a character-agnostic view.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPublicVendorComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        enabled

        +
        enabled: boolean
        + +
        +
        +

        If True, the Vendor is currently accessible.

        +
        +

        If False, they may not actually be visible in the world at the moment.

        +
        +
        +
        + +

        nextRefreshDate

        +
        nextRefreshDate: string
        + +
        +
        +

        The date when this vendor's inventory will next rotate/refresh.

        +
        +

        Note that this is distinct from the date ranges that the vendor is visible/ + available in-game: this field indicates the specific time when the vendor's + available items refresh and rotate, regardless of whether the vendor is actually + available at that time. Unfortunately, these two values may be (and are, for the + case of important vendors like Xur) different.

        +

        Issue https://github.com/Bungie-net/api/issues/353 is tracking a fix to start + providing visibility date ranges where possible in addition to this refresh date, + so that all important dates for vendors are available for use.

        +
        +
        +
        + +

        vendorHash

        +
        vendorHash: number
        + +
        +
        +

        The unique identifier for the vendor. Use it to look up their + DestinyVendorDefinition.

        +
        +

        Mapped to DestinyVendorDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypublicvendorsaleitemcomponent.html b/docs/interfaces/destinypublicvendorsaleitemcomponent.html new file mode 100644 index 0000000..2d22fe4 --- /dev/null +++ b/docs/interfaces/destinypublicvendorsaleitemcomponent.html @@ -0,0 +1,323 @@ + + + + + + DestinyPublicVendorSaleItemComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPublicVendorSaleItemComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Has character-agnostic information about an item being sold by a vendor.

        +
        +

        Note that if you want instance, stats, etc... data for the item, you'll have to + request additional components such as ItemInstances, ItemPerks etc... and + acquire them from the DestinyVendorResponse's "items" property. For most of + these, however, you'll have to ask for it in context of a specific character.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPublicVendorSaleItemComponent +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        costs

        + + +
        +
        +

        A summary of the current costs of the item.

        +
        +
        +
        +
        + +

        itemHash

        +
        itemHash: number
        + +
        +
        +

        The hash of the item being sold, as a quick shortcut for looking up the + DestinyInventoryItemDefinition of the sale item.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        Optional overrideNextRefreshDate

        +
        overrideNextRefreshDate: string
        + +
        +
        +

        If this item has its own custom date where it may be removed from the Vendor's + rotation, this is that date.

        +
        +

        Note that there's not actually any guarantee that it will go away: it could be + chosen again and end up still being in the Vendor's sale items! But this is the + next date where that test will occur, and is also the date that the game shows + for availability on things like Bounties being sold. So it's the best we can + give.

        +
        +
        +
        + +

        Optional overrideStyleItemHash

        +
        overrideStyleItemHash: number
        + +
        +
        +

        If populated, this is the hash of the item whose icon (and other secondary + styles, but not the human readable strings) should override whatever icons/ + styles are on the item being sold.

        +
        +

        If you don't do this, certain items whose styles are being overridden by + socketed items - such as the "Recycle Shader" item - would show whatever their + default icon/style is, and it wouldn't be pretty or look accurate.

        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        quantity

        +
        quantity: number
        + +
        +
        +

        How much of the item you'll be getting.

        +
        +
        +
        +
        + +

        vendorItemIndex

        +
        vendorItemIndex: number
        + +
        +
        +

        The index into the DestinyVendorDefinition.itemList property. Note that this + means Vendor data is Content Version dependent: make sure you have the latest + content before you use Vendor data, or these indexes may mismatch.

        +
        +

        Most systems avoid this problem, but Vendors is one area where we are unable to + reasonably avoid content dependency at the moment.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinypublicvendorsresponse.html b/docs/interfaces/destinypublicvendorsresponse.html new file mode 100644 index 0000000..6adb30b --- /dev/null +++ b/docs/interfaces/destinypublicvendorsresponse.html @@ -0,0 +1,280 @@ + + + + + + DestinyPublicVendorsResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyPublicVendorsResponse

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A response containing all valid components for the public Vendors endpoint.

        +
        +

        It is a decisively smaller subset of data compared to what we can get when we + know the specific user making the request.

        +

        If you want any of the other data - item details, whether or not you can buy it, + etc... you'll have to call in the context of a character. I know, sad but true.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyPublicVendorsResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        categories

        + + +
        +
        +

        Categories that the vendor has available, and references to the sales therein. + These are keyed by the Vendor Hash, so you will get one Categories Component per + vendor returned.

        +
        +

        COMPONENT TYPE: VendorCategories

        +
        +
        +
        + +

        sales

        + + +
        +
        +

        Sales, keyed by the vendorItemIndex of the item being sold. These are keyed by + the Vendor Hash, so you will get one Sale Item Set Component per vendor returned.

        +
        +

        Note that within the Sale Item Set component, the sales are themselves keyed by + the vendorSaleIndex, so you can relate it to the corrent sale item definition + within the Vendor's definition.

        +

        COMPONENT TYPE: VendorSales

        +
        +
        +
        + +

        vendorGroups

        + + +
        +
        +

        For Vendors being returned, this will give you the information you need to group + them and order them in the same way that the Bungie Companion app performs + grouping. It will automatically be returned if you request the Vendors component.

        +
        +

        COMPONENT TYPE: Vendors

        +
        +
        +
        + +

        vendors

        + + +
        +
        +

        The base properties of the vendor. These are keyed by the Vendor Hash, so you + will get one Vendor Component per vendor returned.

        +
        +

        COMPONENT TYPE: Vendors

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyqueststatus.html b/docs/interfaces/destinyqueststatus.html new file mode 100644 index 0000000..f860609 --- /dev/null +++ b/docs/interfaces/destinyqueststatus.html @@ -0,0 +1,375 @@ + + + + + + DestinyQuestStatus | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyQuestStatus

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Data regarding the progress of a Quest for a specific character. Quests are + composed of multiple steps, each with potentially multiple objectives: this + QuestStatus will return Objective data for the currently active step in this + quest.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyQuestStatus +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        completed

        +
        completed: boolean
        + +
        +
        +

        Whether or not the whole quest has been completed, regardless of whether or not + you have redeemed the rewards for the quest.

        +
        +
        +
        +
        + +

        itemInstanceId

        +
        itemInstanceId: string
        + +
        +
        +

        The current Quest Step will be an instanced item in the player's inventory. If + you care about that, this is the instance ID of that item.

        +
        +
        +
        +
        + +

        questHash

        +
        questHash: number
        + +
        +
        +

        The hash identifier for the Quest Item. (Note: Quests are defined as Items, and + thus you would use this to look up the quest's DestinyInventoryItemDefinition). + For information on all steps in the quest, you can then examine its + DestinyInventoryItemDefinition.setData property for Quest Steps (which are also + items). You can use the Item Definition to display human readable data about + the overall quest.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        redeemed

        +
        redeemed: boolean
        + +
        +
        +

        Whether or not you have redeemed rewards for this quest.

        +
        +
        +
        +
        + +

        started

        +
        started: boolean
        + +
        +
        +

        Whether or not you have started this quest.

        +
        +
        +
        +
        + +

        stepHash

        +
        stepHash: number
        + +
        +
        +

        The hash identifier of the current Quest Step, which is also a + DestinyInventoryItemDefinition. You can use this to get human readable data + about the current step and what to do in that step.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        stepObjectives

        +
        stepObjectives: DestinyObjectiveProgress[]
        + +
        +
        +

        A step can have multiple objectives. This will give you the progress for each + objective in the current step, in the order in which they are rendered in-game.

        +
        +
        +
        +
        + +

        tracked

        +
        tracked: boolean
        + +
        +
        +

        Whether or not the quest is tracked

        +
        +
        +
        +
        + +

        Optional vendorHash

        +
        vendorHash: number
        + +
        +
        +

        If the quest has a related Vendor that you should talk to in order to initiate + the quest/earn rewards/continue the quest, this will be the hash identifier of + that Vendor. Look it up its DestinyVendorDefinition.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyracedefinition.html b/docs/interfaces/destinyracedefinition.html new file mode 100644 index 0000000..2b6c90c --- /dev/null +++ b/docs/interfaces/destinyracedefinition.html @@ -0,0 +1,337 @@ + + + + + + DestinyRaceDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyRaceDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        In Destiny, "Races" are really more like "Species". Sort of. I mean, are the + Awoken a separate species from humans? I'm not sure. But either way, they're + defined here. You'll see Exo, Awoken, and Human as examples of these Species. + Players will choose one for their character.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyRaceDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        + +

        genderedRaceNames

        +
        genderedRaceNames: object
        + +
        +
        +

        A localized string referring to the singular form of the Race's name when + referred to in gendered form. Keyed by the DestinyGender.

        +
        +
        +
        +

        Type declaration

        +
          +
        +
        +
        +
        + +

        genderedRaceNamesByGenderHash

        +
        genderedRaceNamesByGenderHash: object
        + +
        +
        +

        Mapped to DestinyGenderDefinition in the manifest.

        +
        +
        +
        +

        Type declaration

        +
          +
        • +
          [key: number]: string
          +
        • +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        raceType

        +
        raceType: DestinyRace
        + +
        +
        +

        An enumeration defining the existing, known Races/Species for player characters. + This value will be the enum value matching this definition.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyrecordcompletionblock.html b/docs/interfaces/destinyrecordcompletionblock.html new file mode 100644 index 0000000..60758ea --- /dev/null +++ b/docs/interfaces/destinyrecordcompletionblock.html @@ -0,0 +1,242 @@ + + + + + + DestinyRecordCompletionBlock | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyRecordCompletionBlock

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyRecordCompletionBlock +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        ScoreValue

        +
        ScoreValue: number
        + +
        +
        + +

        partialCompletionObjectiveCountThreshold

        +
        partialCompletionObjectiveCountThreshold: number
        + +
        +
        +

        The number of objectives that must be completed before the objective is + considered "complete"

        +
        +
        +
        +
        + +

        shouldFireToast

        +
        shouldFireToast: boolean
        + +
        +
        + +

        toastStyle

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyrecordcomponent.html b/docs/interfaces/destinyrecordcomponent.html new file mode 100644 index 0000000..53b937a --- /dev/null +++ b/docs/interfaces/destinyrecordcomponent.html @@ -0,0 +1,214 @@ + + + + + + DestinyRecordComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyRecordComponent

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyRecordComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        objectives

        + + +
        +
        + +

        state

        + + +
        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyrecorddefinition.html b/docs/interfaces/destinyrecorddefinition.html new file mode 100644 index 0000000..bc0c4e1 --- /dev/null +++ b/docs/interfaces/destinyrecorddefinition.html @@ -0,0 +1,433 @@ + + + + + + DestinyRecordDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyRecordDefinition

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyRecordDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        completionInfo

        + + +
        +
        + +

        displayProperties

        + + +
        +
        + +

        expirationInfo

        + + +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        Optional loreHash

        +
        loreHash: number
        + +
        +
        +

        Mapped to DestinyLoreDefinition in the manifest.

        +
        +
        +
        +
        + +

        objectiveHashes

        +
        objectiveHashes: number[]
        + +
        +
        +

        Mapped to DestinyObjectiveDefinition in the manifest.

        +
        +
        +
        +
        + +

        presentationInfo

        + + +
        +
        + +

        recordValueStyle

        +
        recordValueStyle: DestinyRecordValueStyle
        + +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        requirements

        + + +
        +
        + +

        rewardItems

        +
        rewardItems: DestinyItemQuantity[]
        + +
        +
        +

        If there is any publicly available information about rewards earned for + achieving this record, this is the list of those items.

        +
        +

        However, note that some records intentionally have "hidden" rewards. These will + not be returned in this list.

        +
        +
        +
        + +

        scope

        + + +
        +
        +

        Indicates whether this Record's state is determined on a per-character or on an + account-wide basis.

        +
        +
        +
        +
        + +

        stateInfo

        + + +
        +
        + +

        titleInfo

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyrecordexpirationblock.html b/docs/interfaces/destinyrecordexpirationblock.html new file mode 100644 index 0000000..5b27777 --- /dev/null +++ b/docs/interfaces/destinyrecordexpirationblock.html @@ -0,0 +1,230 @@ + + + + + + DestinyRecordExpirationBlock | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyRecordExpirationBlock

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If this record has an expiration after which it cannot be earned, this is some + information about that expiration.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyRecordExpirationBlock +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        description

        +
        description: string
        + +
        +
        + +

        hasExpiration

        +
        hasExpiration: boolean
        + +
        +
        + +

        icon

        +
        icon: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyrecordtitleblock.html b/docs/interfaces/destinyrecordtitleblock.html new file mode 100644 index 0000000..2ee0070 --- /dev/null +++ b/docs/interfaces/destinyrecordtitleblock.html @@ -0,0 +1,241 @@ + + + + + + DestinyRecordTitleBlock | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyRecordTitleBlock

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyRecordTitleBlock +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        hasTitle

        +
        hasTitle: boolean
        + +
        +
        + +

        titlesByGender

        +
        titlesByGender: object
        + +
        +

        Type declaration

        +
          +
        +
        +
        +
        + +

        titlesByGenderHash

        +
        titlesByGenderHash: object
        + +
        +
        +

        For those who prefer to use the definitions.

        +
        +

        Mapped to DestinyGenderDefinition in the manifest.

        +
        +
        +

        Type declaration

        +
          +
        • +
          [key: number]: string
          +
        • +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyreportoffensepgcrrequest.html b/docs/interfaces/destinyreportoffensepgcrrequest.html new file mode 100644 index 0000000..72ea38b --- /dev/null +++ b/docs/interfaces/destinyreportoffensepgcrrequest.html @@ -0,0 +1,262 @@ + + + + + + DestinyReportOffensePgcrRequest | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyReportOffensePgcrRequest

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If you want to report a player causing trouble in a game, this request will let + you report that player and the specific PGCR in which the trouble was caused, + along with why.

        +
        +

        Please don't do this just because you dislike the person! I mean, I know people + will do it anyways, but can you like take a good walk, or put a curse on them or + something? Do me a solid and reconsider.

        +

        Note that this request object doesn't have the actual PGCR ID nor your Account/ + Character ID in it. We will infer that information from your authentication + information and the PGCR ID that you pass into the URL of the reporting endpoint + itself.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyReportOffensePgcrRequest +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        offendingCharacterId

        +
        offendingCharacterId: string
        + +
        +
        +

        Within the PGCR provided when calling the Reporting endpoint, this should be the + character ID of the user that you thought was violating terms of use. They must + exist in the PGCR provided.

        +
        +
        +
        +
        + +

        reasonCategoryHashes

        +
        reasonCategoryHashes: number[]
        + +
        +
        +

        So you've decided to report someone instead of cursing them and their + descendants. Well, okay then. This is the category or categorie(s) of + infractions for which you are reporting the user. These are hash identifiers + that map to DestinyReportReasonCategoryDefinition entries.

        +
        +

        Mapped to DestinyReportReasonCategoryDefinition in the manifest.

        +
        +
        +
        + +

        reasonHashes

        +
        reasonHashes: number[]
        + +
        +
        +

        If applicable, provide a more specific reason(s) within the general category of + problems provided by the reasonHash. This is also an identifier for a reason. + All reasonHashes provided must be children of at least one the + reasonCategoryHashes provided.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyreportreasoncategorydefinition.html b/docs/interfaces/destinyreportreasoncategorydefinition.html new file mode 100644 index 0000000..7babf4f --- /dev/null +++ b/docs/interfaces/destinyreportreasoncategorydefinition.html @@ -0,0 +1,295 @@ + + + + + + DestinyReportReasonCategoryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyReportReasonCategoryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If you're going to report someone for a Terms of Service violation, you need to + choose a category and reason for the report. This definition holds both the + categories and the reasons within those categories, for simplicity and my own + laziness' sake.

        +
        +

        Note tha this means that, to refer to a Reason by reasonHash, you need a + combination of the reasonHash and the associated ReasonCategory's hash: there + are some reasons defined under multiple categories.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyReportReasonCategoryDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        reasons

        +
        reasons: object
        + +
        +
        +

        The specific reasons for the report under this category.

        +
        +
        +
        +

        Type declaration

        + +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyreportreasondefinition.html b/docs/interfaces/destinyreportreasondefinition.html new file mode 100644 index 0000000..52866a7 --- /dev/null +++ b/docs/interfaces/destinyreportreasondefinition.html @@ -0,0 +1,224 @@ + + + + + + DestinyReportReasonDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyReportReasonDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A specific reason for being banned. Only accessible under the related category ( + DestinyReportReasonCategoryDefinition) under which it is shown. Note that this + means that report reasons' reasonHash are not globally unique: and indeed, + entries like "Other" are defined under most categories for example.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyReportReasonDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        + +

        reasonHash

        +
        reasonHash: number
        + +
        +
        +

        The identifier for the reason: they are only guaranteed unique under the + Category in which they are found.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyrewardsourcedefinition.html b/docs/interfaces/destinyrewardsourcedefinition.html new file mode 100644 index 0000000..85eb31d --- /dev/null +++ b/docs/interfaces/destinyrewardsourcedefinition.html @@ -0,0 +1,295 @@ + + + + + + DestinyRewardSourceDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyRewardSourceDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents a heuristically-determined "item source" according to Bungie.net. + These item sources are non-canonical: we apply a combination of special + configuration and often-fragile heuristics to attempt to discern whether an item + should be part of a given "source," but we have known cases of false positives + and negatives due to our imperfect heuristics.

        +
        +

        Still, they provide a decent approximation for people trying to figure out how + an item can be obtained. DestinyInventoryItemDefinition refers to sources in the + sourceDatas.sourceHashes property for all sources we determined the item could + spawn from.

        +

        An example in Destiny 1 of a Source would be "Nightfall". If an item has the " + Nightfall" source associated with it, it's extremely likely that you can earn + that item while playing Nightfall, either during play or as an after-completion + reward.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyRewardSourceDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        category

        + + +
        +
        +

        Sources are grouped into categories: common ways that items are provided. I hope + to see this expand in Destiny 2 once we have time to generate accurate reward + source data.

        +
        +
        +
        +
        + +

        displayProperties

        + + +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinysandboxperkdefinition.html b/docs/interfaces/destinysandboxperkdefinition.html new file mode 100644 index 0000000..698bff6 --- /dev/null +++ b/docs/interfaces/destinysandboxperkdefinition.html @@ -0,0 +1,391 @@ + + + + + + DestinySandboxPerkDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinySandboxPerkDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Perks are modifiers to a character or item that can be applied situationally.

        +
        +
          +
        • Perks determine a weapons' damage type.

          +
        • +
        • Perks put the Mods in Modifiers (they are literally the entity that bestows + the Sandbox benefit for whatever fluff text about the modifier in the Socket, + Plug or Talent Node)

          +
        • +
        • Perks are applied for unique alterations of state in Objectives

          +
        • +
        +

        Anyways, I'm sure you can see why perks are so interesting.

        +

        What Perks often don't have is human readable information, so we attempt to + reverse engineer that by pulling that data from places that uniquely refer to + these perks: namely, Talent Nodes and Plugs. That only gives us a subset of + perks that are human readable, but those perks are the ones people generally + care about anyways. The others are left as a mystery, their true purpose mostly + unknown and undocumented.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinySandboxPerkDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        damageType

        +
        damageType: DamageType
        + +
        +
        +

        If this perk grants a damage type to a weapon, the damage type will be defined + here.

        +
        +

        Unless you have a compelling reason to use this enum value, use the + damageTypeHash instead to look up the actual DestinyDamageTypeDefinition.

        +
        +
        +
        + +

        Optional damageTypeHash

        +
        damageTypeHash: number
        + +
        +
        +

        The hash identifier for looking up the DestinyDamageTypeDefinition, if this perk + has a damage type.

        +
        +

        This is preferred over using the damageType enumeration value, which has been + left purely because it is occasionally convenient.

        +
        +
        +
        + +

        displayProperties

        + + +
        +
        +

        These display properties are by no means guaranteed to be populated. Usually + when it is, it's only because we back-filled them with the displayProperties of + some Talent Node or Plug item that happened to be uniquely providing that perk.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        isDisplayable

        +
        isDisplayable: boolean
        + +
        +
        +

        If true, you can actually show the perk in the UI. Otherwise, it doesn't have + useful player-facing information.

        +
        +
        +
        +
        + +

        perkGroups

        + + +
        +
        +

        An old holdover from the original Armory, this was an attempt to group perks by + functionality.

        +
        +

        It is as yet unpopulated, and there will be quite a bit of work needed to + restore it to its former working order.

        +
        +
        +
        + +

        perkIdentifier

        +
        perkIdentifier: string
        + +
        +
        +

        The string identifier for the perk.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinysocketcategorydefinition.html b/docs/interfaces/destinysocketcategorydefinition.html new file mode 100644 index 0000000..8cc72e9 --- /dev/null +++ b/docs/interfaces/destinysocketcategorydefinition.html @@ -0,0 +1,318 @@ + + + + + + DestinySocketCategoryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinySocketCategoryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Sockets on an item are organized into Categories visually.

        +
        +

        You can find references to the socket category defined on an item's + DestinyInventoryItemDefinition.sockets.socketCategories property.

        +

        This has the display information for rendering the categories' header, and a + hint for how the UI should handle showing this category.

        +

        The shitty thing about this, however, is that the socket categories' UI style + can be overridden by the item's UI style. For instance, the Socket Category used + by Emote Sockets says it's "consumable," but that's a lie: they're all reusable, + and overridden by the detail UI pages in ways that we can't easily account for + in the API.

        +

        As a result, I will try to compile these rules into the individual sockets on + items, and provide the best hint possible there through the plugSources property. + In the future, I may attempt to use this information in conjunction with the + item to provide a more usable UI hint on the socket layer, but for now improving + the consistency of plugSources is the best I have time to provide. (See https:// + github.com/Bungie-net/api/issues/522 for more info)

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinySocketCategoryDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        categoryStyle

        + + +
        +
        +

        Same as uiCategoryStyle, but in a more usable enumeration form.

        +
        +
        +
        +
        + +

        displayProperties

        + + +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        uiCategoryStyle

        +
        uiCategoryStyle: number
        + +
        +
        +

        A string hinting to the game's UI system about how the sockets in this category + should be displayed.

        +
        +

        BNet doesn't use it: it's up to you to find valid values and make your own + special UI if you want to honor this category style.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinysockettypedefinition.html b/docs/interfaces/destinysockettypedefinition.html new file mode 100644 index 0000000..6a6205f --- /dev/null +++ b/docs/interfaces/destinysockettypedefinition.html @@ -0,0 +1,449 @@ + + + + + + DestinySocketTypeDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinySocketTypeDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        All Sockets have a "Type": a set of common properties that determine when the + socket allows Plugs to be inserted, what Categories of Plugs can be inserted, + and whether the socket is even visible at all given the current game/character/ + account state.

        +
        +

        See DestinyInventoryItemDefinition for more information about Socketed items and + Plugs.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinySocketTypeDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        alwaysRandomizeSockets

        +
        alwaysRandomizeSockets: boolean
        + +
        +
        + +

        avoidDuplicatesOnInitialization

        +
        avoidDuplicatesOnInitialization: boolean
        + +
        +
        + +

        currencyScalars

        + + +
        +
        + +

        displayProperties

        + + +
        +
        +

        There are fields for this display data, but they appear to be unpopulated as of + now. I am not sure where in the UI these would show if they even were populated, + but I will continue to return this data in case it becomes useful.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        hideDuplicateReusablePlugs

        +
        hideDuplicateReusablePlugs: boolean
        + +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        insertAction

        + + +
        +
        +

        Defines what happens when a plug is inserted into sockets of this type.

        +
        +
        +
        +
        + +

        isPreviewEnabled

        +
        isPreviewEnabled: boolean
        + +
        +
        + +

        overridesUiAppearance

        +
        overridesUiAppearance: boolean
        + +
        +
        +

        This property indicates if the socket type determines whether Emblem icons and + nameplates should be overridden by the inserted plug item's icon and nameplate.

        +
        +
        +
        +
        + +

        plugWhitelist

        + + +
        +
        +

        A list of Plug "Categories" that are allowed to be plugged into sockets of this + type.

        +
        +

        These should be compared against a given plug item's + DestinyInventoryItemDefinition.plug.plugCategoryHash, which indicates the plug + item's category.

        +

        If the plug's category matches any whitelisted plug, or if the whitelist is + empty, it is allowed to be inserted.

        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        socketCategoryHash

        +
        socketCategoryHash: number
        + +
        +
        +

        Mapped to DestinySocketCategoryDefinition in the manifest.

        +
        +
        +
        +
        + +

        visibility

        + + +
        +
        +

        Sometimes a socket isn't visible. These are some of the conditions under which + sockets of this type are not visible. Unfortunately, the truth of visibility is + much, much more complex. Best to rely on the live data for whether the socket is + visible and enabled.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinysockettypescalarmaterialrequiremententry.html b/docs/interfaces/destinysockettypescalarmaterialrequiremententry.html new file mode 100644 index 0000000..14daa94 --- /dev/null +++ b/docs/interfaces/destinysockettypescalarmaterialrequiremententry.html @@ -0,0 +1,208 @@ + + + + + + DestinySocketTypeScalarMaterialRequirementEntry | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinySocketTypeScalarMaterialRequirementEntry

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinySocketTypeScalarMaterialRequirementEntry +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        currencyItemHash

        +
        currencyItemHash: number
        + +
        +
        + +

        scalarValue

        +
        scalarValue: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinystat.html b/docs/interfaces/destinystat.html new file mode 100644 index 0000000..095d330 --- /dev/null +++ b/docs/interfaces/destinystat.html @@ -0,0 +1,250 @@ + + + + + + DestinyStat | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyStat

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents a stat on an item or Character (NOT a Historical Stat, but a + physical attribute stat like Attack, Defense etc...)

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyStat +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        maximumValue

        +
        maximumValue: number
        + +
        +
        +

        The highest possible value for the stat, if we were able to compute it. (I + wouldn't necessarily trust this value right now. I would like to improve its + calculation in later iterations of the API. Consider this a placeholder for + desired future functionality)

        +
        +
        +
        +
        + +

        statHash

        +
        statHash: number
        + +
        +
        +

        The hash identifier for the Stat. Use it to look up the DestinyStatDefinition + for static data about the stat.

        +
        +

        Mapped to DestinyStatDefinition in the manifest.

        +
        +
        +
        + +

        value

        +
        value: number
        + +
        +
        +

        The current value of the Stat.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinystatdefinition.html b/docs/interfaces/destinystatdefinition.html new file mode 100644 index 0000000..5dcba9d --- /dev/null +++ b/docs/interfaces/destinystatdefinition.html @@ -0,0 +1,364 @@ + + + + + + DestinyStatDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyStatDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This represents a stat that's applied to a character or an item (such as a + weapon, piece of armor, or a vehicle).

        +
        +

        An example of a stat might be Attack Power on a weapon.

        +

        Stats go through a complex set of transformations before they end up being shown + to the user as a number or a progress bar, and those transformations are + fundamentally intertwined with the concept of a "Stat Group" ( + DestinyStatGroupDefinition). Items have both Stats and a reference to a Stat + Group, and it is the Stat Group that takes the raw stat information and gives it + both rendering metadata (such as whether to show it as a number or a progress + bar) and the final transformation data (interpolation tables to turn the raw + investment stat into a display stat). Please see DestinyStatGroupDefinition for + more information on that transformational process.

        +

        Stats are segregated from Stat Groups because different items and types of items + can refer to the same stat, but have different "scales" for the stat while still + having the same underlying value. For example, both a Shotgun and an Auto Rifle + may have a "raw" impact stat of 50, but the Auto Rifle's Stat Group will scale + that 50 down so that, when it is displayed, it is a smaller value relative to + the shotgun. (this is a totally made up example, don't assume shotguns have + naturally higher impact than auto rifles because of this)

        +

        A final caveat is that some stats, even after this "final" transformation, go + through yet another set of transformations directly in the game as a result of + dynamic, stateful scripts that get run. BNet has no access to these scripts, nor + any way to know which scripts get executed. As a result, the stats for an item + that you see in-game - particularly for stats that are often impacted by Perks, + like Magazine Size - can change dramatically from what we return on Bungie.Net. + This is a known issue with no fix coming down the pipeline. Take these stats + with a grain of salt.

        +

        Stats actually go through four transformations, for those interested:

        +

        1) "Sandbox" stat, the "most raw" form. These are pretty much useless without + transformations applied, and thus are not currently returned in the API. If you + really want these, we can provide them. Maybe someone could do something cool + with it?

        +

        2) "Investment" stat (the stat's value after DestinyStatDefinition's + interpolation tables and aggregation logic is applied to the "Sandbox" stat + value)

        +

        3) "Display" stat (the stat's base UI-visible value after + DestinyStatGroupDefinition's interpolation tables are applied to the Investment + Stat value. For most stats, this is what is displayed.)

        +

        4) Underlying in-game stat (the stat's actual value according to the game, after + the game runs dynamic scripts based on the game and character's state. This is + the final transformation that BNet does not have access to. For most stats, this + is not actually displayed to the user, with the exception of Magazine Size which + is then piped back to the UI for display in-game, but not to BNet.)

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyStatDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        aggregationType

        + + +
        +
        +

        Stats can exist on a character or an item, and they may potentially be + aggregated in different ways. The DestinyStatAggregationType enum value + indicates the way that this stat is being aggregated.

        +
        +
        +
        +
        + +

        displayProperties

        + + +
        +
        + +

        hasComputedBlock

        +
        hasComputedBlock: boolean
        + +
        +
        +

        True if the stat is computed rather than being delivered as a raw value on items.

        +
        +

        For instance, the Light stat in Destiny 1 was a computed stat.

        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        statCategory

        +
        statCategory: DestinyStatCategory
        + +
        +
        +

        The category of the stat, according to the game.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinystatdisplaydefinition.html b/docs/interfaces/destinystatdisplaydefinition.html new file mode 100644 index 0000000..cd72717 --- /dev/null +++ b/docs/interfaces/destinystatdisplaydefinition.html @@ -0,0 +1,277 @@ + + + + + + DestinyStatDisplayDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyStatDisplayDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Describes the way that an Item Stat (see DestinyStatDefinition) is transformed + using the DestinyStatGroupDefinition related to that item. See both of the + aforementioned definitions for more information about the stages of stat + transformation.

        +
        +

        This represents the transformation of a stat into a "Display" stat (the closest + value that BNet can get to the in-game display value of the stat)

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyStatDisplayDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        displayAsNumeric

        +
        displayAsNumeric: boolean
        + +
        +
        +

        If this is true, the stat should be displayed as a number. Otherwise, display it + as a progress bar. Or, you know, do whatever you want. There's no + displayAsNumeric police.

        +
        +
        +
        +
        + +

        displayInterpolation

        +
        displayInterpolation: InterpolationPoint[]
        + +
        +
        +

        The interpolation table representing how the Investment Stat is transformed into + a Display Stat.

        +
        +

        See DestinyStatDefinition for a description of the stages of stat transformation.

        +
        +
        +
        + +

        maximumValue

        +
        maximumValue: number
        + +
        +
        +

        Regardless of the output of interpolation, this is the maximum possible value + that the stat can be. It should also be used as the upper bound for displaying + the stat as a progress bar (the minimum always being 0)

        +
        +
        +
        +
        + +

        statHash

        +
        statHash: number
        + +
        +
        +

        The hash identifier for the stat being transformed into a Display stat.

        +
        +

        Use it to look up the DestinyStatDefinition, or key into a + DestinyInventoryItemDefinition's stats property.

        +

        Mapped to DestinyStatDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinystatgroupdefinition.html b/docs/interfaces/destinystatgroupdefinition.html new file mode 100644 index 0000000..9065b1a --- /dev/null +++ b/docs/interfaces/destinystatgroupdefinition.html @@ -0,0 +1,356 @@ + + + + + + DestinyStatGroupDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyStatGroupDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        When an inventory item (DestinyInventoryItemDefinition) has Stats (such as + Attack Power), the item will refer to a Stat Group. This definition enumerates + the properties used to transform the item's "Investment" stats into "Display" + stats.

        +
        +

        See DestinyStatDefinition's documentation for information about the + transformation of Stats, and the meaning of an Investment vs. a Display stat.

        +

        If you don't want to do these calculations on your own, fear not: pulling live + data from the BNet endpoints will return display stat values pre-computed and + ready for you to use. I highly recommend this approach, saves a lot of time and + also accounts for certain stat modifiers that can't easily be accounted for + without live data (such as stat modifiers on Talent Grids and Socket Plugs)

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyStatGroupDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        maximumValue

        +
        maximumValue: number
        + +
        +
        +

        The maximum possible value that any stat in this group can be transformed into.

        +
        +

        This is used by stats that don't have scaledStats entries below, but that + still need to be displayed as a progress bar, in which case this is used as the + upper bound for said progress bar. (the lower bound is always 0)

        +
        +
        +
        + +

        overrides

        +
        overrides: object
        + +
        +
        +

        The game has the ability to override, based on the stat group, what the + localized text is that is displayed for Stats being shown on the item.

        +
        +

        Mercifully, no Stat Groups use this feature currently. If they start using them, + we'll all need to start using them (and those of you who are more prudent than I + am can go ahead and start pre-checking for this.)

        +
        +
        +

        Type declaration

        + +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        scaledStats

        + + +
        +
        +

        Any stat that requires scaling to be transformed from an "Investment" stat to a " + Display" stat will have an entry in this list. For more information on what + those types of stats mean and the transformation process, see + DestinyStatDefinition.

        +
        +

        In retrospect, I wouldn't mind if this was a dictionary keyed by the stat hash + instead. But I'm going to leave it be because [[After Apple Picking]].

        +
        +
        +
        + +

        uiPosition

        +
        uiPosition: number
        + +
        +
        +

        This apparently indicates the position of the stats in the UI? I've returned it + in case anyone can use it, but it's not of any use to us on BNet. Something's + being lost in translation with this value.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinystatoverridedefinition.html b/docs/interfaces/destinystatoverridedefinition.html new file mode 100644 index 0000000..07369df --- /dev/null +++ b/docs/interfaces/destinystatoverridedefinition.html @@ -0,0 +1,239 @@ + + + + + + DestinyStatOverrideDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyStatOverrideDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Stat Groups (DestinyStatGroupDefinition) has the ability to override the + localized text associated with stats that are to be shown on the items with + which they are associated.

        +
        +

        This defines a specific overridden stat. You could theoretically check these + before rendering your stat UI, and for each stat that has an override show these + displayProperties instead of those on the DestinyStatDefinition.

        +

        Or you could be like us, and skip that for now because the game has yet to + actually use this feature. But know that it's here, waiting for a resilliant + young designer to take up the mantle and make us all look foolish by showing the + wrong name for stats.

        +

        Note that, if this gets used, the override will apply only to items using the + overriding Stat Group. Other items will still show the default stat's name/ + description.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyStatOverrideDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        +

        The display properties to show instead of the base DestinyStatDefinition display + properties.

        +
        +
        +
        +
        + +

        statHash

        +
        statHash: number
        + +
        +
        +

        The hash identifier of the stat whose display properties are being overridden.

        +
        +

        Mapped to DestinyStatDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinytalentexclusivegroup.html b/docs/interfaces/destinytalentexclusivegroup.html new file mode 100644 index 0000000..2513b21 --- /dev/null +++ b/docs/interfaces/destinytalentexclusivegroup.html @@ -0,0 +1,293 @@ + + + + + + DestinyTalentExclusiveGroup | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyTalentExclusiveGroup

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        As of Destiny 2, nodes can exist as part of "Exclusive Groups". These differ + from exclusive sets in that, within the group, many nodes can be activated. But + the act of activating any node in the group will cause "opposing" nodes (nodes + in groups that are not allowed to be activated at the same time as this group) + to deactivate.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyTalentExclusiveGroup +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        groupHash

        +
        groupHash: number
        + +
        +
        +

        The identifier for this exclusive group. Only guaranteed unique within the + talent grid, not globally.

        +
        +
        +
        +
        + +

        Optional loreHash

        +
        loreHash: number
        + +
        +
        +

        If this group has an associated piece of lore to show next to it, this will be + the identifier for that DestinyLoreDefinition.

        +
        +

        Mapped to DestinyLoreDefinition in the manifest.

        +
        +
        +
        + +

        nodeHashes

        +
        nodeHashes: number[]
        + +
        +
        +

        A quick reference of the talent nodes that are part of this group, by their + Talent Node hashes. (See DestinyTalentNodeDefinition.nodeHash)

        +
        +
        +
        +
        + +

        opposingGroupHashes

        +
        opposingGroupHashes: number[]
        + +
        +
        +

        A quick reference of Groups whose nodes will be deactivated if any node in this + group is activated.

        +
        +
        +
        +
        + +

        opposingNodeHashes

        +
        opposingNodeHashes: number[]
        + +
        +
        +

        A quick reference of Nodes that will be deactivated if any node in this group is + activated, by their Talent Node hashes. (See DestinyTalentNodeDefinition. + nodeHash)

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinytalentgriddefinition.html b/docs/interfaces/destinytalentgriddefinition.html new file mode 100644 index 0000000..80e519c --- /dev/null +++ b/docs/interfaces/destinytalentgriddefinition.html @@ -0,0 +1,477 @@ + + + + + + DestinyTalentGridDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyTalentGridDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The time has unfortunately come to talk about Talent Grids.

        +
        +

        Talent Grids are the most complex and unintuitive part of the Destiny Definition + data. Grab a cup of coffee before we begin, I can wait.

        +

        Talent Grids were the primary way that items could be customized in Destiny 1. + In Destiny 2, for now, talent grids have become exclusively used by Subclass/ + Build items: but the system is still in place for it to be used by items should + the direction change back toward talent grids.

        +

        Talent Grids have Nodes: the visual circles on the talent grid detail screen + that have icons and can be activated if you meet certain requirements and pay + costs. The actual visual data and effects, however, are driven by the "Steps" on + Talent Nodes. Any given node will have 1:M of these steps, and the specific step + that will be considered the "current" step (and thus the dictator of all + benefits, visual state, and activation requirements on the Node) will almost + always not be determined until an instance of the item is created. This is how, + in Destiny 1, items were able to have such a wide variety of what users saw as " + Perks": they were actually Talent Grids with nodes that had a wide variety of + Steps, randomly chosen at the time of item creation.

        +

        Now that Talent Grids are used exclusively by subclasses and builds, all of the + properties within still apply: but there are additional visual elements on the + Subclass/Build screens that are superimposed on top of the talent nodes. + Unfortunately, BNet doesn't have this data: if you want to build a subclass + screen, you will have to provide your own "decorative" assets, such as the + visual connectors between nodes and the fancy colored-fire-bathed character + standing behind the nodes.

        +

        DestinyInventoryItem.talentGrid.talentGridHash defines an item's linked Talent + Grid, which brings you to this definition that contains enough satic data about + talent grids to make your head spin. These must be combined with instanced + data - found when live data returns DestinyItemTalentGridComponent - in order to + derive meaning. The instanced data will reference nodes and steps within these + definitions, which you will then have to look up in the definition and combine + with the instanced data to give the user the visual representation of their item' + s talent grid.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyTalentGridDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        exclusiveSets

        + + +
        +
        +

        Talent Nodes can exist in "exclusive sets": these are sets of nodes in which + only a single node in the set can be activated at any given time. Activating a + node in this set will automatically deactivate the other nodes in the set ( + referred to as a "Swap").

        +
        +

        If a node in the exclusive set has already been activated, the game will not + charge you materials to activate another node in the set, even if you have never + activated it before, because you already paid the cost to activate one node in + the set.

        +

        Not to be confused with Exclusive Groups. (how the heck do we NOT get confused + by that? Jeez) See the groups property for information about that only- + tangentially-related concept.

        +
        +
        +
        + +

        gridLevelPerColumn

        +
        gridLevelPerColumn: number
        + +
        +
        +

        The meaning of this has been lost in the sands of time: it still exists as a + property, but appears to be unused in the modern UI of talent grids. It used to + imply that each visual "column" of talent nodes required identical progression + levels in order to be activated. Returning this value in case it is still useful + to someone? Perhaps it's just a bit of interesting history.

        +
        +
        +
        +
        + +

        groups

        +
        groups: object
        + +
        +
        +

        Talent Nodes can have "Exclusive Groups". These are not to be confused with + Exclusive Sets (see exclusiveSets property).

        +
        +

        Look at the definition of DestinyTalentExclusiveGroup for more information and + how they work. These groups are keyed by the "groupHash" from + DestinyTalentExclusiveGroup.

        +
        +
        +

        Type declaration

        + +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        independentNodeIndexes

        +
        independentNodeIndexes: number[]
        + +
        +
        +

        This is a quick reference to the indexes of nodes that are not part of exclusive + sets. Handy for knowing which talent nodes can only be activated directly, + rather than via swapping.

        +
        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        maxGridLevel

        +
        maxGridLevel: number
        + +
        +
        +

        The maximum possible level of the Talent Grid: at this level, any nodes are + allowed to be activated.

        +
        +
        +
        +
        + +

        nodeCategories

        +
        nodeCategories: DestinyTalentNodeCategory[]
        + +
        +
        +

        BNet wants to show talent nodes grouped by similar purpose with localized titles. + This is the ordered list of those categories: if you want to show nodes by + category, you can iterate over this list, render the displayProperties for the + category as the title, and then iterate over the talent nodes referenced by the + category to show the related nodes.

        +
        +

        Note that this is different from Exclusive Groups or Sets, because these + categories also incorporate "Independent" nodes that belong to neither sets nor + groups. These are purely for visual grouping of nodes rather than functional + grouping.

        +
        +
        +
        + +

        nodes

        + + +
        +
        +

        The list of Talent Nodes on the Grid (recall that Nodes themselves are really + just locations in the UI to show whatever their current Step is. You will only + know the current step for a node by retrieving instanced data through platform + calls to the API that return DestinyItemTalentGridComponent).

        +
        +
        +
        +
        + +

        progressionHash

        +
        progressionHash: number
        + +
        +
        +

        The hash identifier of the Progression (DestinyProgressionDefinition) that + drives whether and when Talent Nodes can be activated on the Grid. Items will + have instances of this Progression, and will gain experience that will + eventually cause the grid to increase in level. As the grid's level increases, + it will cross the threshold where nodes can be activated. See + DestinyTalentGridStepDefinition's activation requirements for more information.

        +
        +

        Mapped to DestinyProgressionDefinition in the manifest.

        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinytalentnode.html b/docs/interfaces/destinytalentnode.html new file mode 100644 index 0000000..2e8c3ac --- /dev/null +++ b/docs/interfaces/destinytalentnode.html @@ -0,0 +1,414 @@ + + + + + + DestinyTalentNode | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyTalentNode

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        I see you've come to find out more about Talent Nodes. I'm so sorry. Talent + Nodes are the conceptual, visual nodes that appear on Talent Grids. Talent Grids, + in Destiny 1, were found on almost every instanced item: they had Nodes that + could be activated to change the properties of the item. In Destiny 2, Talent + Grids only exist for Builds/Subclasses, and while the basic concept is the same ( + Nodes can be activated once you've gained sufficient Experience on the Item, and + provide effects), there are some new concepts from Destiny 1. Examine + DestinyTalentGridDefinition and its subordinates for more information. This is + the "Live" information for the current status of a Talent Node on a specific + item. Talent Nodes have many Steps, but only one can be active at any one time: + and it is the Step that determines both the visual and the game state-changing + properties that the Node provides. Examine this and + DestinyTalentNodeStepDefinition carefully. IMPORTANT NOTE Talent Nodes are, + unfortunately, Content Version DEPENDENT. Though they refer to hashes for Nodes + and Steps, those hashes are not guaranteed to be immutable across content + versions. This is a source of great exasperation for me, but as a result anyone + using Talent Grid data must ensure that the content version of their static + content matches that of the server responses before showing or making decisions + based on talent grid data.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyTalentNode +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activationGridLevel

        +
        activationGridLevel: number
        + +
        +
        +

        The progression level required on the Talent Grid in order to be able to + activate this talent node. Talent Grids have their own Progression - similar to + Character Level, but in this case it is experience related to the item itself.

        +
        +
        +
        +
        + +

        hidden

        +
        hidden: boolean
        + +
        +
        +

        Whether or not the talent node is actually visible in the game's UI. Whether you + want to show it in your own UI is up to you! I'm not gonna tell you who to sock + it to.

        +
        +
        +
        +
        + +

        isActivated

        +
        isActivated: boolean
        + +
        +
        +

        If true, the node is activated: it's current step then provides its benefits.

        +
        +
        +
        +
        + +

        materialsToUpgrade

        +
        materialsToUpgrade: DestinyMaterialRequirement[]
        + +
        +
        +

        If the node has material requirements to be activated, this is the list of those + requirements.

        +
        +
        +
        +
        + +

        nodeHash

        +
        nodeHash: number
        + +
        +
        +

        The hash of the Talent Node being referred to (in DestinyTalentGridDefinition. + nodes). Deceptively CONTENT VERSION DEPENDENT. We have no guarantee of the hash' + s immutability between content versions.

        +
        +
        +
        +
        + +

        nodeIndex

        +
        nodeIndex: number
        + +
        +
        +

        The index of the Talent Node being referred to (an index into + DestinyTalentGridDefinition.nodes[]). CONTENT VERSION DEPENDENT.

        +
        +
        +
        +
        + +

        nodeStatsBlock

        + + +
        +
        +

        This property has some history. A talent grid can provide stats on both the item + it's related to and the character equipping the item. This returns data about + those stat bonuses.

        +
        +
        +
        +
        + +

        progressPercent

        +
        progressPercent: number
        + +
        +
        +

        If you want to show a progress bar or circle for how close this talent node is + to being activate-able, this is the percentage to show. It follows the node's + underlying rules about when the progress bar should first show up, and when it + should be filled.

        +
        +
        +
        +
        + +

        state

        + + +
        +
        +

        An DestinyTalentNodeState enum value indicating the node's state: whether it can + be activated or swapped, and why not if neither can be performed.

        +
        +
        +
        +
        + +

        stepIndex

        +
        stepIndex: number
        + +
        +
        +

        The currently relevant Step for the node. It is this step that has rendering + data for the node and the benefits that are provided if the node is activated. ( + the actual rules for benefits provided are extremely complicated in theory, but + with how Talent Grids are being used in Destiny 2 you don't have to worry about + a lot of those old Destiny 1 rules.) This is an index into: + DestinyTalentGridDefinition.nodes[nodeIndex].steps[stepIndex]

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinytalentnodecategory.html b/docs/interfaces/destinytalentnodecategory.html new file mode 100644 index 0000000..6cc3214 --- /dev/null +++ b/docs/interfaces/destinytalentnodecategory.html @@ -0,0 +1,272 @@ + + + + + + DestinyTalentNodeCategory | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyTalentNodeCategory

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        An artificial construct provided by Bungie.Net, where we attempt to group talent + nodes by functionality.

        +
        +

        This is a single set of references to Talent Nodes that share a common trait or + purpose.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyTalentNodeCategory +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        +

        Will contain at least the "name", which will be the title of the category. We + will likely not have description and an icon yet, but I'm going to keep my + options open.

        +
        +
        +
        +
        + +

        identifier

        +
        identifier: string
        + +
        +
        +

        Mostly just for debug purposes, but if you find it useful you can have it. This + is BNet's manually created identifier for this category.

        +
        +
        +
        +
        + +

        isLoreDriven

        +
        isLoreDriven: boolean
        + +
        +
        +

        If true, we found the localized content in a related DestinyLoreDefinition + instead of local BNet localization files. This is mostly for ease of my own + future investigations.

        +
        +
        +
        +
        + +

        nodeHashes

        +
        nodeHashes: number[]
        + +
        +
        +

        The set of all hash identifiers for Talent Nodes (DestinyTalentNodeDefinition) + in this Talent Grid that are part of this Category.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinytalentnodedefinition.html b/docs/interfaces/destinytalentnodedefinition.html new file mode 100644 index 0000000..a72743c --- /dev/null +++ b/docs/interfaces/destinytalentnodedefinition.html @@ -0,0 +1,609 @@ + + + + + + DestinyTalentNodeDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyTalentNodeDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Talent Grids on items have Nodes. These nodes have positions in the talent grid' + s UI, and contain "Steps" (DestinyTalentNodeStepDefinition), one of whom will be + the "Current" step.

        +
        +

        The Current Step determines the visual properties of the node, as well as what + the node grants when it is activated.

        +

        See DestinyTalentGridDefinition for a more complete overview of how Talent Grids + work, and how they are used in Destiny 2 (and how they were used in Destiny 1).

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyTalentNodeDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        autoUnlocks

        +
        autoUnlocks: boolean
        + +
        +
        +

        If true, this node will automatically unlock when the Talent Grid's level + reaches the required level of the current step of this node.

        +
        +
        +
        +
        + +

        binaryPairNodeIndex

        +
        binaryPairNodeIndex: number
        + +
        +
        +

        At one point, Talent Nodes supported the idea of "Binary Pairs": nodes that + overlapped each other visually, and where activating one deactivated the other. + They ended up not being used, mostly because Exclusive Sets are almost a + superset of this concept, but the potential for it to be used still exists in + theory.

        +
        +

        If this is ever used, this will be the index into the + DestinyTalentGridDefinition.nodes property for the node that is the binary pair + match to this node. Activating one deactivates the other.

        +
        +
        +
        + +

        column

        +
        column: number
        + +
        +
        +

        The visual "column" where the node should be shown in the UI. If negative, the + node is hidden.

        +
        +
        +
        +
        + +

        exclusiveWithNodeHashes

        +
        exclusiveWithNodeHashes: number[]
        + +
        +
        +

        The nodeHash values for nodes that are in an Exclusive Set with this node.

        +
        +

        See DestinyTalentGridDefinition.exclusiveSets for more info about exclusive sets.

        +

        Again, note that these are nodeHashes and not nodeIndexes.

        +
        +
        +
        + +

        Optional groupHash

        +
        groupHash: number
        + +
        +
        +

        As of Destiny 2, nodes can exist as part of "Exclusive Groups". These differ + from exclusive sets in that, within the group, many nodes can be activated. But + the act of activating any node in the group will cause "opposing" nodes (nodes + in groups that are not allowed to be activated at the same time as this group) + to deactivate.

        +
        +

        See DestinyTalentExclusiveGroup for more information on the details. This is an + identifier for this node's group, if it is part of one.

        +
        +
        +
        + +

        ignoreForCompletion

        +
        ignoreForCompletion: boolean
        + +
        +
        +

        Comes from the talent grid node style: if true, then this node should be ignored + for determining whether the grid is complete.

        +
        +
        +
        +
        + +

        isRandom

        +
        isRandom: boolean
        + +
        +
        +

        If this is true, the node's step is determined randomly rather than the first + step being chosen.

        +
        +
        +
        +
        + +

        isRandomRepurchasable

        +
        isRandomRepurchasable: boolean
        + +
        +
        +

        If this is true, the node can be "re-rolled" to acquire a different random + current step. This is not used, but still exists for a theoretical future of + talent grids.

        +
        +
        +
        +
        + +

        lastStepRepeats

        +
        lastStepRepeats: boolean
        + +
        +
        +

        At one point, Nodes were going to be able to be activated multiple times, + changing the current step and potentially piling on multiple effects from the + previously activated steps. This property would indicate if the last step could + be activated multiple times.

        +
        +

        This is not currently used, but it isn't out of the question that this could end + up being used again in a theoretical future.

        +
        +
        +
        + +

        layoutIdentifier

        +
        layoutIdentifier: string
        + +
        +
        +

        A string identifier for a custom visual layout to apply to this talent node. + Unfortunately, we do not have any data for rendering these custom layouts. It + will be up to you to interpret these strings and change your UI if you want to + have custom UI matching these layouts.

        +
        +
        +
        +
        + +

        Optional loreHash

        +
        loreHash: number
        + +
        +
        +

        Talent nodes can be associated with a piece of Lore, generally rendered in a + tooltip. This is the hash identifier of the lore element to show, if there is + one to be show.

        +
        +

        Mapped to DestinyLoreDefinition in the manifest.

        +
        +
        +
        + +

        nodeHash

        +
        nodeHash: number
        + +
        +
        +

        The hash identifier for the node, which unfortunately is also content version + dependent but can be (and ideally, should be) used instead of the nodeIndex to + uniquely identify the node.

        +
        +

        The two exist side-by-side for backcompat reasons due to the Great Talent Node + Restructuring of Destiny 1, and I ran out of time to remove one of them and + standardize on the other. Sorry!

        +
        +
        +
        + +

        nodeIndex

        +
        nodeIndex: number
        + +
        +
        +

        The index into the DestinyTalentGridDefinition's "nodes" property where this + node is located. Used to uniquely identify the node within the Talent Grid. Note + that this is content version dependent: make sure you have the latest version of + content before trying to use these properties.

        +
        +
        +
        +
        + +

        nodeStyleIdentifier

        +
        nodeStyleIdentifier: string
        + +
        +
        +

        Comes from the talent grid node style: this identifier should be used to + determine how to render the node in the UI.

        +
        +
        +
        +
        + +

        prerequisiteNodeIndexes

        +
        prerequisiteNodeIndexes: number[]
        + +
        +
        +

        Indexes into the DestinyTalentGridDefinition.nodes property for any nodes that + must be activated before this one is allowed to be activated.

        +
        +

        I would have liked to change this to hashes for Destiny 2, but we have run out + of time.

        +
        +
        +
        + +

        randomActivationRequirement

        +
        randomActivationRequirement: DestinyNodeActivationRequirement
        + +
        +
        +

        At one point, you were going to be able to repurchase talent nodes that had + random steps, to "re-roll" the current step of the node (and thus change the + properties of your item). This was to be the activation requirement for + performing that re-roll.

        +
        +

        The system still exists to do this, as far as I know, so it may yet come back + around!

        +
        +
        +
        + +

        randomStartProgressionBarAtProgression

        +
        randomStartProgressionBarAtProgression: number
        + +
        +
        +

        If the node's step is randomly selected, this is the amount of the Talent Grid's + progression experience at which the progression bar for the node should be shown.

        +
        +
        +
        +
        + +

        row

        +
        row: number
        + +
        +
        +

        The visual "row" where the node should be shown in the UI. If negative, then the + node is hidden.

        +
        +
        +
        +
        + +

        steps

        + + +
        +
        +

        At this point, "steps" have been obfuscated into conceptual entities, + aggregating the underlying notions of "properties" and "true steps".

        +
        +

        If you need to know a step as it truly exists - such as when recreating Node + logic when processing Vendor data - you'll have to use the "realSteps" property + below.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinytalentnodeexclusivesetdefinition.html b/docs/interfaces/destinytalentnodeexclusivesetdefinition.html new file mode 100644 index 0000000..8661142 --- /dev/null +++ b/docs/interfaces/destinytalentnodeexclusivesetdefinition.html @@ -0,0 +1,209 @@ + + + + + + DestinyTalentNodeExclusiveSetDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyTalentNodeExclusiveSetDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The list of indexes into the Talent Grid's "nodes" property for nodes in this + exclusive set. (See DestinyTalentNodeDefinition.nodeIndex)

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyTalentNodeExclusiveSetDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        nodeIndexes

        +
        nodeIndexes: number[]
        + +
        +
        +

        The list of node indexes for the exclusive set. Historically, these were indexes. + I would have liked to replace this with nodeHashes for consistency, but it's + way too late for that. (9:09 PM, he's right!)

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinytalentnodestatblock.html b/docs/interfaces/destinytalentnodestatblock.html new file mode 100644 index 0000000..3d733aa --- /dev/null +++ b/docs/interfaces/destinytalentnodestatblock.html @@ -0,0 +1,234 @@ + + + + + + DestinyTalentNodeStatBlock | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyTalentNodeStatBlock

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This property has some history. A talent grid can provide stats on both the item + it's related to and the character equipping the item. This returns data about + those stat bonuses.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyTalentNodeStatBlock +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        currentStepStats

        +
        currentStepStats: DestinyStat[]
        + +
        +
        +

        The stat benefits conferred when this talent node is activated for the current + Step that is active on the node.

        +
        +
        +
        +
        + +

        nextStepStats

        +
        nextStepStats: DestinyStat[]
        + +
        +
        +

        This is a holdover from the old days of Destiny 1, when a node could be + activated multiple times, conferring multiple steps worth of benefits: you would + use this property to show what activating the "next" step on the node would + provide vs. what the current step is providing. While Nodes are currently not + being used this way, the underlying system for this functionality still exists. + I hesitate to remove this property while the ability for designers to make such + a talent grid still exists. Whether you want to show it is up to you.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinytalentnodestepgroups.html b/docs/interfaces/destinytalentnodestepgroups.html new file mode 100644 index 0000000..6046e16 --- /dev/null +++ b/docs/interfaces/destinytalentnodestepgroups.html @@ -0,0 +1,289 @@ + + + + + + DestinyTalentNodeStepGroups | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyTalentNodeStepGroups

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        These properties are an attempt to categorize talent node steps by certain + common properties. See the related enumerations for the type of properties being + categorized.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyTalentNodeStepGroups +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        damageTypes

        + + +
        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        +
        + +

        guardianAttributes

        + + +
        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        +
        + +

        impactEffects

        + + +
        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        +
        + +

        lightAbilities

        + + +
        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        +
        + +

        weaponPerformance

        + + +
        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyunlockdefinition.html b/docs/interfaces/destinyunlockdefinition.html new file mode 100644 index 0000000..efda5f8 --- /dev/null +++ b/docs/interfaces/destinyunlockdefinition.html @@ -0,0 +1,272 @@ + + + + + + DestinyUnlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyUnlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Unlock Flags are small bits (literally, a bit, as in a boolean value) that the + game server uses for an extremely wide range of state checks, progress storage, + and other interesting tidbits of information.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyUnlockDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayProperties

        + + +
        +
        +

        Sometimes, but not frequently, these unlock flags also have human readable + information: usually when they are being directly tested for some requirement, + in which case the string is a localized description of why the requirement check + failed.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyunlockexpressiondefinition.html b/docs/interfaces/destinyunlockexpressiondefinition.html new file mode 100644 index 0000000..45162cd --- /dev/null +++ b/docs/interfaces/destinyunlockexpressiondefinition.html @@ -0,0 +1,212 @@ + + + + + + DestinyUnlockExpressionDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyUnlockExpressionDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Where the sausage gets made. Unlock Expressions are the foundation of the game's + gating mechanics and investment-related restrictions. They can test Unlock Flags + and Unlock Values for certain states, using a sufficient amount of logical + operators such that unlock expressions are effectively Turing complete.

        +
        +

        Use UnlockExpressionParser to evaluate expressions using an IUnlockContext + parsed from Babel.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyUnlockExpressionDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        scope

        + + +
        +
        +

        A shortcut for determining the most restrictive gating that this expression + performs. See the DestinyGatingScope enum's documentation for more details.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyunlockstatus.html b/docs/interfaces/destinyunlockstatus.html new file mode 100644 index 0000000..c06aa09 --- /dev/null +++ b/docs/interfaces/destinyunlockstatus.html @@ -0,0 +1,233 @@ + + + + + + DestinyUnlockStatus | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyUnlockStatus

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Indicates the status of an "Unlock Flag" on a Character or Profile.

        +
        +

        These are individual bits of state that can be either set or not set, and + sometimes provide interesting human-readable information in their related + DestinyUnlockDefinition.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyUnlockStatus +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        isSet

        +
        isSet: boolean
        + +
        +
        +

        Whether the unlock flag is set.

        +
        +
        +
        +
        + +

        unlockHash

        +
        unlockHash: number
        + +
        +
        +

        The hash identifier for the Unlock Flag. Use to lookup DestinyUnlockDefinition + for static data. Not all unlocks have human readable data - in fact, most don't. + But when they do, it can be very useful to show. Even if they don't have human + readable data, you might be able to infer the meaning of an unlock flag with a + bit of experimentation...

        +
        +

        Mapped to DestinyUnlockDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyunlockvaluedefinition.html b/docs/interfaces/destinyunlockvaluedefinition.html new file mode 100644 index 0000000..452f7da --- /dev/null +++ b/docs/interfaces/destinyunlockvaluedefinition.html @@ -0,0 +1,252 @@ + + + + + + DestinyUnlockValueDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyUnlockValueDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        An Unlock Value is an internal integer value, stored on the server and used in a + variety of ways, most frequently for the gating/requirement checks that the game + performs across all of its main features. They can also be used as the storage + data for mapped Progressions, Objectives, and other features that require + storage of variable numeric values.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyUnlockValueDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendoraccepteditemdefinition.html b/docs/interfaces/destinyvendoraccepteditemdefinition.html new file mode 100644 index 0000000..88eeb84 --- /dev/null +++ b/docs/interfaces/destinyvendoraccepteditemdefinition.html @@ -0,0 +1,239 @@ + + + + + + DestinyVendorAcceptedItemDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorAcceptedItemDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If you ever wondered how the Vault works, here it is.

        +
        +

        The Vault is merely a set of inventory buckets that exist on your Profile/ + Account level. When you transfer items in the Vault, the game is using the Vault + Vendor's DestinyVendorAcceptedItemDefinitions to see where the appropriate + destination bucket is for the source bucket from whence your item is moving. If + it finds such an entry, it transfers the item to the other bucket.

        +

        The mechanics for Postmaster works similarly, which is also a vendor. All driven + by Accepted Items.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorAcceptedItemDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        acceptedInventoryBucketHash

        +
        acceptedInventoryBucketHash: number
        + +
        +
        +

        The "source" bucket for a transfer. When a user wants to transfer an item, the + appropriate DestinyVendorDefinition's acceptedItems property is evaluated, + looking for an entry where acceptedInventoryBucketHash matches the bucket that + the item being transferred is currently located. If it exists, the item will be + transferred into whatever bucket is defined by destinationInventoryBucketHash.

        +
        +

        Mapped to DestinyInventoryBucketDefinition in the manifest.

        +
        +
        +
        + +

        destinationInventoryBucketHash

        +
        destinationInventoryBucketHash: number
        + +
        +
        +

        This is the bucket where the item being transferred will be put, given that it + was being transferred from the bucket defined in acceptedInventoryBucketHash.

        +
        +

        Mapped to DestinyInventoryBucketDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendoractiondefinition.html b/docs/interfaces/destinyvendoractiondefinition.html new file mode 100644 index 0000000..012f150 --- /dev/null +++ b/docs/interfaces/destinyvendoractiondefinition.html @@ -0,0 +1,316 @@ + + + + + + DestinyVendorActionDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorActionDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If a vendor can ever end up performing actions, these are the properties that + will be related to those actions. I'm not going to bother documenting this yet, + as it is unused and unclear if it will ever be used... but in case it is ever + populated and someone finds it useful, it is defined here.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorActionDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        actionHash

        +
        actionHash: number
        + +
        +
        + +

        actionId

        +
        actionId: string
        + +
        +
        + +

        autoPerformAction

        +
        autoPerformAction: boolean
        + +
        +
        + +

        description

        +
        description: string
        + +
        +
        + +

        executeSeconds

        +
        executeSeconds: number
        + +
        +
        + +

        icon

        +
        icon: string
        + +
        +
        + +

        isPositive

        +
        isPositive: boolean
        + +
        +
        + +

        name

        +
        name: string
        + +
        +
        + +

        verb

        +
        verb: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorcategoriescomponent.html b/docs/interfaces/destinyvendorcategoriescomponent.html new file mode 100644 index 0000000..5da2ce8 --- /dev/null +++ b/docs/interfaces/destinyvendorcategoriescomponent.html @@ -0,0 +1,213 @@ + + + + + + DestinyVendorCategoriesComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorCategoriesComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A vendor can have many categories of items that they sell. This component will + return the category information for available items, as well as the index into + those items in the user's sale item list.

        +
        +

        Note that, since both the category and items are indexes, this data is Content + Version dependent. Be sure to check that your content is up to date before using + this data. This is an unfortunate, but permanent, limitation of Vendor data.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorCategoriesComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        categories

        +
        categories: DestinyVendorCategory[]
        + +
        +
        +

        The list of categories for items that the vendor sells, in rendering order.

        +
        +

        These categories each point to a "display category" in the displayCategories + property of the DestinyVendorDefinition, as opposed to the other categories.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorcategory.html b/docs/interfaces/destinyvendorcategory.html new file mode 100644 index 0000000..2cb4fdf --- /dev/null +++ b/docs/interfaces/destinyvendorcategory.html @@ -0,0 +1,229 @@ + + + + + + DestinyVendorCategory | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorCategory

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Information about the category and items currently sold in that category.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorCategory +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayCategoryIndex

        +
        displayCategoryIndex: number
        + +
        +
        +

        An index into the DestinyVendorDefinition.displayCategories property, so you can + grab the display data for this category.

        +
        +
        +
        +
        + +

        itemIndexes

        +
        itemIndexes: number[]
        + +
        +
        +

        An ordered list of indexes into items being sold in this category ( + DestinyVendorDefinition.itemList) which will contain more information about the + items being sold themselves. Can also be used to index into + DestinyVendorSaleItemComponent data, if you asked for that data to be returned.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorcategoryentrydefinition.html b/docs/interfaces/destinyvendorcategoryentrydefinition.html new file mode 100644 index 0000000..55cf513 --- /dev/null +++ b/docs/interfaces/destinyvendorcategoryentrydefinition.html @@ -0,0 +1,511 @@ + + + + + + DestinyVendorCategoryEntryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorCategoryEntryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This is the definition for a single Vendor Category, into which Sale Items are + grouped.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorCategoryEntryDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        buyStringOverride

        +
        buyStringOverride: string
        + +
        +
        +

        The localized string for making purchases from this category, if it is different + from the vendor's string for purchasing.

        +
        +
        +
        +
        + +

        categoryHash

        +
        categoryHash: number
        + +
        +
        +

        The hashed identifier for the category.

        +
        +
        +
        +
        + +

        categoryId

        +
        categoryId: string
        + +
        +
        +

        The string identifier of the category.

        +
        +
        +
        +
        + +

        categoryIndex

        +
        categoryIndex: number
        + +
        +
        +

        The index of the category in the original category definitions for the vendor.

        +
        +
        +
        +
        + +

        disabledDescription

        +
        disabledDescription: string
        + +
        +
        +

        If the category is disabled, this is the localized description to show.

        +
        +
        +
        +
        + +

        displayTitle

        +
        displayTitle: string
        + +
        +
        +

        The localized title of the category.

        +
        +
        +
        +
        + +

        hideFromRegularPurchase

        +
        hideFromRegularPurchase: boolean
        + +
        +
        +

        True if this category doesn't allow purchases.

        +
        +
        +
        +
        + +

        hideIfNoCurrency

        +
        hideIfNoCurrency: boolean
        + +
        +
        +

        If you don't have the currency required to buy items from this category, should + the items be hidden?

        +
        +
        +
        +
        + +

        isDisplayOnly

        +
        isDisplayOnly: boolean
        + +
        +
        +

        If true, this category only displays items: you can't purchase anything in them.

        +
        +
        +
        +
        + +

        isPreview

        +
        isPreview: boolean
        + +
        +
        +

        Sometimes a category isn't actually used to sell items, but rather to preview + them. This implies different UI (and manual placement of the category in the UI) + in the game, and special treatment.

        +
        +
        +
        +
        + +

        overlay

        + + +
        +
        +

        If this category has an overlay prompt that should appear, this contains the + details of that prompt.

        +
        +
        +
        +
        + +

        quantityAvailable

        +
        quantityAvailable: number
        + +
        +
        +

        The amount of items that will be available when this category is shown.

        +
        +
        +
        +
        + +

        resetIntervalMinutesOverride

        +
        resetIntervalMinutesOverride: number
        + +
        +
        + +

        resetOffsetMinutesOverride

        +
        resetOffsetMinutesOverride: number
        + +
        +
        + +

        showUnavailableItems

        +
        showUnavailableItems: boolean
        + +
        +
        +

        If items aren't up for sale in this category, should we still show them (greyed + out)?

        +
        +
        +
        +
        + +

        sortValue

        +
        sortValue: number
        + +
        +
        +

        Used in sorting items in vendors... but there's a lot more to it. Just go with + the order provided in the itemIndexes property on the + DestinyVendorCategoryComponent instead, it should be more reliable than trying + to recalculate it yourself.

        +
        +
        +
        +
        + +

        vendorItemIndexes

        +
        vendorItemIndexes: number[]
        + +
        +
        +

        A shortcut for the vendor item indexes sold under this category. Saves us from + some expensive reorganization at runtime.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorcategoryoverlaydefinition.html b/docs/interfaces/destinyvendorcategoryoverlaydefinition.html new file mode 100644 index 0000000..b1dec30 --- /dev/null +++ b/docs/interfaces/destinyvendorcategoryoverlaydefinition.html @@ -0,0 +1,263 @@ + + + + + + DestinyVendorCategoryOverlayDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorCategoryOverlayDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The details of an overlay prompt to show to a user. They are all fairly self- + explanatory localized strings that can be shown.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorCategoryOverlayDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        choiceDescription

        +
        choiceDescription: string
        + +
        +
        + +

        Optional currencyItemHash

        +
        currencyItemHash: number
        + +
        +
        +

        If this overlay has a currency item that it features, this is said featured item.

        +
        +
        +
        +
        + +

        description

        +
        description: string
        + +
        +
        + +

        icon

        +
        icon: string
        + +
        +
        + +

        title

        +
        title: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorcomponent.html b/docs/interfaces/destinyvendorcomponent.html new file mode 100644 index 0000000..e8acb20 --- /dev/null +++ b/docs/interfaces/destinyvendorcomponent.html @@ -0,0 +1,339 @@ + + + + + + DestinyVendorComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This component contains essential/summary information about the vendor.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorComponent +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        canPurchase

        +
        canPurchase: boolean
        + +
        +
        +

        If True, you can purchase from the Vendor.

        +
        +

        Theoretically, Vendors can be restricted from selling items. In practice, none + do that (yet?).

        +
        +
        +
        + +

        enabled

        +
        enabled: boolean
        + +
        +
        +

        If True, the Vendor is currently accessible.

        +
        +

        If False, they may not actually be visible in the world at the moment.

        +
        +
        +
        + +

        nextRefreshDate

        +
        nextRefreshDate: string
        + +
        +
        +

        The date when this vendor's inventory will next rotate/refresh.

        +
        +

        Note that this is distinct from the date ranges that the vendor is visible/ + available in-game: this field indicates the specific time when the vendor's + available items refresh and rotate, regardless of whether the vendor is actually + available at that time. Unfortunately, these two values may be (and are, for the + case of important vendors like Xur) different.

        +

        Issue https://github.com/Bungie-net/api/issues/353 is tracking a fix to start + providing visibility date ranges where possible in addition to this refresh date, + so that all important dates for vendors are available for use.

        +
        +
        +
        + +

        progression

        +
        progression: DestinyProgression
        + +
        +
        +

        If the Vendor has a related Reputation, this is the Progression data that + represents the character's Reputation level with this Vendor.

        +
        +
        +
        +
        + +

        Optional seasonalRank

        +
        seasonalRank: number
        + +
        +
        +

        If this vendor has a seasonal rank, this will be the calculated value of that + rank. How nice is that? I mean, that's pretty sweeet. It's a whole 32 bit + integer.

        +
        +
        +
        +
        + +

        vendorHash

        +
        vendorHash: number
        + +
        +
        +

        The unique identifier for the vendor. Use it to look up their + DestinyVendorDefinition.

        +
        +

        Mapped to DestinyVendorDefinition in the manifest.

        +
        +
        +
        + +

        vendorLocationIndex

        +
        vendorLocationIndex: number
        + +
        +
        +

        An index into the vendor definition's "locations" property array, indicating + which location they are at currently. If -1, then the vendor has no known + location (and you may choose not to show them in your UI as a result. I mean, it' + s your bag honey)

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendordefinition.html b/docs/interfaces/destinyvendordefinition.html new file mode 100644 index 0000000..4bc5efc --- /dev/null +++ b/docs/interfaces/destinyvendordefinition.html @@ -0,0 +1,930 @@ + + + + + + DestinyVendorDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        These are the definitions for Vendors.

        +
        +

        In Destiny, a Vendor can be a lot of things - some things that you wouldn't + expect, and some things that you don't even see directly in the game. Vendors + are the Dolly Levi of the Destiny universe.

        +
          +
        • Traditional Vendors as you see in game: people who you come up to and who give + you quests, rewards, or who you can buy things from.

          +
        • +
        • Kiosks/Collections, which are really just Vendors that don't charge currency ( + or charge some pittance of a currency) and whose gating for purchases revolves + more around your character's state.

          +
        • +
        • Previews for rewards or the contents of sacks. These are implemented as + Vendors, where you can't actually purchase from them but the items that they + have for sale and the categories of sale items reflect the rewards or contents + of the sack. This is so that the game could reuse the existing Vendor display UI + for rewards and save a bunch of wheel reinvention.

          +
        • +
        • Item Transfer capabilities, like the Vault and Postmaster. Vendors can have " + acceptedItem" buckets that determine the source and destination buckets for + transfers. When you interact with such a vendor, these buckets are what gets + shown in the UI instead of any items that the Vendor would have for sale. Yep, + the Vault is a vendor.

          +
        • +
        +

        It is pretty much guaranteed that they'll be used for even more features in the + future. They have come to be seen more as generic categorized containers for + items than "vendors" in a traditional sense, for better or worse.

        +

        Where possible and time allows, we'll attempt to split those out into their own + more digestible derived "Definitions": but often time does not allow that, as + you can see from the above ways that vendors are used which we never split off + from Vendor Definitions externally.

        +

        Since Vendors are so many things to so many parts of the game, the definition is + understandably complex. You will want to combine this data with live Vendor + information from the API when it is available.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        acceptedItems

        + + +
        +
        +

        If the Vendor is actually a vehicle for the transferring of items (like the + Vault and Postmaster vendors), this defines the list of source->destination + buckets for transferring.

        +
        +
        +
        +
        + +

        actions

        + + +
        +
        +

        Describes "actions" that can be performed on a vendor. Currently, none of these + exist. But theoretically a Vendor could let you interact with it by performing + actions. We'll see what these end up looking like if they ever get used.

        +
        +
        +
        +
        + +

        buyString

        +
        buyString: string
        + +
        +
        +

        If the vendor has a custom localized string describing the "buy" action, that is + returned here.

        +
        +
        +
        +
        + +

        categories

        + + +
        +
        +

        These are the headers for sections of items that the vendor is selling. When you + see items organized by category in the header, it is these categories that it is + showing.

        +
        +

        Well, technically not exactly these. On BNet, it doesn't make sense to have + categories be "paged" as we do in Destiny, so we run some heuristics to attempt + to aggregate pages of categories together.

        +

        These are the categories post-concatenation, if the vendor had concatenation + applied. If you want the pre-aggregated category data, use originalCategories.

        +
        +
        +
        + +

        consolidateCategories

        +
        consolidateCategories: boolean
        + +
        +
        +

        If TRUE, consolidate categories that only differ by trivial properties (such as + having minor differences in name)

        +
        +
        +
        +
        + +

        displayCategories

        + + +
        +
        +

        Display Categories are different from "categories" in that these are + specifically for visual grouping and display of categories in Vendor UI.

        +
        +

        The "categories" structure is for validation of the contained items, and can be + categorized entirely separately from "Display Categories", there need be and + often will be no meaningful relationship between the two.

        +
        +
        +
        + +

        displayItemHash

        +
        displayItemHash: number
        + +
        +
        +

        If the vendor has an item that should be displayed as the "featured" item, this + is the hash identifier for that DestinyVendorItemDefinition.

        +
        +

        Apparently this is usually a related currency, like a reputation token. But it + need not be restricted to that.

        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        displayProperties

        + + +
        +
        + +

        enabled

        +
        enabled: boolean
        + +
        +
        +

        If a vendor is not enabled, we won't even save the vendor's definition, and we + won't return any items or info about them. It's as if they don't exist.

        +
        +
        +
        +
        + +

        factionHash

        +
        factionHash: number
        + +
        +
        +

        If the Vendor has a faction, this hash will be valid and point to a + DestinyFactionDefinition.

        +
        +

        The game UI and BNet often mine the faction definition for additional elements + and details to place on the screen, such as the faction's Progression status ( + aka "Reputation").

        +

        Mapped to DestinyFactionDefinition in the manifest.

        +
        +
        +
        + +

        failureStrings

        +
        failureStrings: string[]
        + +
        +
        +

        If an item can't be purchased from the vendor, there may be many "custom"/game + state specific reasons why not.

        +
        +

        This is a list of localized strings with messages for those custom failures. The + live BNet data will return a failureIndexes property for items that can't be + purchased: using those values to index into this array, you can show the user + the appropriate failure message for the item that can't be bought.

        +
        +
        +
        + +

        groups

        + + +
        +
        +

        A vendor can be a part of 0 or 1 "groups" at a time: a group being a collection + of Vendors related by either location or function/purpose. It's used for our our + Companion Vendor UI. Only one of these can be active for a Vendor at a time.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        ignoreSaleItemHashes

        +
        ignoreSaleItemHashes: number[]
        + +
        +
        +

        Some items don't make sense to return in the API, for example because they + represent an action to be performed rather than an item being sold. I'd rather + we not do this, but at least in the short term this is a workable workaround.

        +
        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        inhibitBuying

        +
        inhibitBuying: boolean
        + +
        +
        +

        If this is true, you aren't allowed to buy whatever the vendor is selling.

        +
        +
        +
        +
        + +

        inhibitSelling

        +
        inhibitSelling: boolean
        + +
        +
        +

        If this is true, you're not allowed to sell whatever the vendor is buying.

        +
        +
        +
        +
        + +

        interactions

        + + +
        +
        +

        In addition to selling items, vendors can have "interactions": UI where you " + talk" with the vendor and they offer you a reward, some item, or merely + acknowledge via dialog that you did something cool.

        +
        +
        +
        +
        + +

        inventoryFlyouts

        + + +
        +
        +

        If the vendor shows you items from your own inventory - such as the Vault vendor + does - this data describes the UI around showing those inventory buckets and + which ones get shown.

        +
        +
        +
        +
        + +

        itemList

        + + +
        +
        +

        If the vendor sells items (or merely has a list of items to show like the "Sack" + vendors do), this is the list of those items that the vendor can sell. From this + list, only a subset will be available from the vendor at any given time, + selected randomly and reset on the vendor's refresh interval.

        +
        +

        Note that a vendor can sell the same item multiple ways: for instance, nothing + stops a vendor from selling you some specific weapon but using two different + currencies, or the same weapon at multiple "item levels".

        +
        +
        +
        + +

        locations

        + + +
        +
        +

        A vendor can be at different places in the world depending on the game/character/ + account state. This is the list of possible locations for the vendor, along with + conditions we use to determine which one is currently active.

        +
        +
        +
        +
        + +

        originalCategories

        + + +
        +
        +

        See the categories property for a description of categories and why + originalCategories exists.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        + +

        resetIntervalMinutes

        +
        resetIntervalMinutes: number
        + +
        +
        +

        A number used for calculating the frequency of a vendor's inventory resetting/ + refreshing.

        +
        +

        Don't worry about calculating this - we do it on the server side and send you + the next refresh date with the live data.

        +
        +
        +
        + +

        resetOffsetMinutes

        +
        resetOffsetMinutes: number
        + +
        +
        +

        Again, used for reset/refreshing of inventory. Don't worry too much about it. + Unless you want to.

        +
        +
        +
        +
        + +

        returnWithVendorRequest

        +
        returnWithVendorRequest: boolean
        + +
        +
        +

        As many of you know, Vendor data has historically been pretty brutal on the BNet + servers. In an effort to reduce this workload, only Vendors with this flag set + will be returned on Vendor requests. This allows us to filter out Vendors that + don't dynamic data that's particularly useful: things like "Preview/Sack" + vendors, for example, that you can usually suss out the details for using just + the definitions themselves.

        +
        +
        +
        +
        + +

        sellString

        +
        sellString: string
        + +
        +
        +

        Ditto for selling. Not that you can sell items to a vendor anymore. Will it come + back? Who knows. The string's still there.

        +
        +
        +
        +
        + +

        services

        + + +
        +
        +

        BNet doesn't use this data yet, but it appears to be an optional list of flavor + text about services that the Vendor can provide.

        +
        +
        +
        +
        + +

        unlockRanges

        +
        unlockRanges: DateRange[]
        + +
        +
        +

        If we were able to predict the dates when this Vendor will be visible/available, + this will be the list of those date ranges. Sadly, we're not able to predict + this very frequently, so this will often be useless data.

        +
        +
        +
        +
        + +

        vendorBanner

        +
        vendorBanner: string
        + +
        +
        +

        If the vendor has a custom banner image, that can be found here.

        +
        +
        +
        +
        + +

        vendorIdentifier

        +
        vendorIdentifier: string
        + +
        +
        +

        The internal identifier for the Vendor. A holdover from the old days of Vendors, + but we don't have time to refactor it away.

        +
        +
        +
        +
        + +

        vendorPortrait

        +
        vendorPortrait: string
        + +
        +
        +

        A portrait of the Vendor's smiling mug. Or frothing tentacles.

        +
        +
        +
        +
        + +

        vendorSubcategoryIdentifier

        +
        vendorSubcategoryIdentifier: string
        + +
        +
        +

        The identifier of the VendorCategoryDefinition for this vendor's subcategory.

        +
        +
        +
        +
        + +

        visible

        +
        visible: boolean
        + +
        +
        +

        If a vendor is not visible, we still have and will give vendor definition info, + but we won't use them for things like Advisors or UI.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendordisplaypropertiesdefinition.html b/docs/interfaces/destinyvendordisplaypropertiesdefinition.html new file mode 100644 index 0000000..26b2fe3 --- /dev/null +++ b/docs/interfaces/destinyvendordisplaypropertiesdefinition.html @@ -0,0 +1,383 @@ + + + + + + DestinyVendorDisplayPropertiesDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorDisplayPropertiesDefinition

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorDisplayPropertiesDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        description

        +
        description: string
        + +
        +
        + +

        hasIcon

        +
        hasIcon: boolean
        + +
        +
        + +

        icon

        +
        icon: string
        + +
        +
        +

        Note that "icon" is sometimes misleading, and should be interpreted in the + context of the entity. For instance, in Destiny 1 the + DestinyRecordBookDefinition's icon was a big picture of a book.

        +
        +

        But usually, it will be a small square image that you can use as... well, an + icon.

        +

        They are currently represented as 96px x 96px images.

        +
        +
        +
        + +

        largeIcon

        +
        largeIcon: string
        + +
        +
        +

        I regret calling this a "large icon". It's more like a medium-sized image with a + picture of the vendor's mug on it, trying their best to look cool. Not what one + would call an icon.

        +
        +
        +
        +
        + +

        largeTransparentIcon

        +
        largeTransparentIcon: string
        + +
        +
        +

        This is apparently the "Watermark". I am not certain offhand where this is + actually used in the Game UI, but some people may find it useful.

        +
        +
        +
        +
        + +

        mapIcon

        +
        mapIcon: string
        + +
        +
        +

        This is the icon used in the map overview, when the vendor is located on the map.

        +
        +
        +
        +
        + +

        name

        +
        name: string
        + +
        +
        + +

        originalIcon

        +
        originalIcon: string
        + +
        +
        +

        If we replaced the icon with something more glitzy, this is the original icon + that the vendor had according to the game's content. It may be more lame and/or + have less razzle-dazzle. But who am I to tell you which icon to use.

        +
        +
        +
        +
        + +

        requirementsDisplay

        + + +
        +
        +

        Vendors, in addition to expected display property data, may also show some " + common requirements" as statically defined definition data. This might be when a + vendor accepts a single type of currency, or when the currency is unique to the + vendor and the designers wanted to show that currency when you interact with the + vendor.

        +
        +
        +
        +
        + +

        smallTransparentIcon

        +
        smallTransparentIcon: string
        + +
        +
        +

        This is the icon used in parts of the game UI such as the vendor's waypoint.

        +
        +
        +
        +
        + +

        subtitle

        +
        subtitle: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorgroup.html b/docs/interfaces/destinyvendorgroup.html new file mode 100644 index 0000000..dedb69d --- /dev/null +++ b/docs/interfaces/destinyvendorgroup.html @@ -0,0 +1,229 @@ + + + + + + DestinyVendorGroup | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorGroup

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Represents a specific group of vendors that can be rendered in the recommended + order.

        +
        +

        How do we figure out this order? It's a long story, and will likely get more + complicated over time.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorGroup +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        vendorGroupHash

        +
        vendorGroupHash: number
        + +
        +
        +

        Mapped to DestinyVendorGroupDefinition in the manifest.

        +
        +
        +
        +
        + +

        vendorHashes

        +
        vendorHashes: number[]
        + +
        +
        +

        The ordered list of vendors within a particular group.

        +
        +

        Mapped to DestinyVendorDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorgroupcomponent.html b/docs/interfaces/destinyvendorgroupcomponent.html new file mode 100644 index 0000000..6c2508c --- /dev/null +++ b/docs/interfaces/destinyvendorgroupcomponent.html @@ -0,0 +1,208 @@ + + + + + + DestinyVendorGroupComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorGroupComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This component returns references to all of the Vendors in the response, grouped + by categorizations that Bungie has deemed to be interesting, in the order in + which both the groups and the vendors within that group should be rendered.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorGroupComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        groups

        + + +
        +
        +

        The ordered list of groups being returned.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorgroupdefinition.html b/docs/interfaces/destinyvendorgroupdefinition.html new file mode 100644 index 0000000..4fb87e3 --- /dev/null +++ b/docs/interfaces/destinyvendorgroupdefinition.html @@ -0,0 +1,294 @@ + + + + + + DestinyVendorGroupDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorGroupDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        BNet attempts to group vendors into similar collections. These groups aren't + technically game canonical, but they are helpful for filtering vendors or + showing them organized into a clean view on a webpage or app.

        +
        +

        These definitions represent the groups we've built. Unlike in Destiny 1, a + Vendors' group may change dynamically as the game state changes: thus, you will + want to check DestinyVendorComponent responses to find a vendor's currently + active Group (if you care).

        +

        Using this will let you group your vendors in your UI in a similar manner to how + we will do grouping in the Companion.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorGroupDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        categoryName

        +
        categoryName: string
        + +
        +
        +

        For now, a group just has a name.

        +
        +
        +
        +
        + +

        hash

        +
        hash: number
        + +
        +
        +

        The unique identifier for this entity. Guaranteed to be unique for the type of + entity, but not globally.

        +
        +

        When entities refer to each other in Destiny content, it is this hash that they + are referring to.

        +
        +
        +
        + +

        index

        +
        index: number
        + +
        +
        +

        The index of the entity as it was found in the investment tables.

        +
        +
        +
        +
        + +

        order

        +
        order: number
        + +
        +
        +

        The recommended order in which to render the groups, Ascending order.

        +
        +
        +
        +
        + +

        redacted

        +
        redacted: boolean
        + +
        +
        +

        If this is true, then there is an entity with this identifier/type combination, + but BNet is not yet allowed to show it. Sorry!

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorgroupreference.html b/docs/interfaces/destinyvendorgroupreference.html new file mode 100644 index 0000000..3e616f5 --- /dev/null +++ b/docs/interfaces/destinyvendorgroupreference.html @@ -0,0 +1,200 @@ + + + + + + DestinyVendorGroupReference | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorGroupReference

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorGroupReference +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        vendorGroupHash

        +
        vendorGroupHash: number
        + +
        +
        +

        The DestinyVendorGroupDefinition to which this Vendor can belong.

        +
        +

        Mapped to DestinyVendorGroupDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorinteractiondefinition.html b/docs/interfaces/destinyvendorinteractiondefinition.html new file mode 100644 index 0000000..271ab10 --- /dev/null +++ b/docs/interfaces/destinyvendorinteractiondefinition.html @@ -0,0 +1,451 @@ + + + + + + DestinyVendorInteractionDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorInteractionDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A Vendor Interaction is a dialog shown by the vendor other than sale items or + transfer screens. The vendor is showing you something, and asking you to reply + to it by choosing an option or reward.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorInteractionDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        flavorLineOne

        +
        flavorLineOne: string
        + +
        +
        +

        If the vendor interaction has flavor text, this is some of it.

        +
        +
        +
        +
        + +

        flavorLineTwo

        +
        flavorLineTwo: string
        + +
        +
        +

        If the vendor interaction has flavor text, this is the rest of it.

        +
        +
        +
        +
        + +

        headerDisplayProperties

        +
        headerDisplayProperties: DestinyDisplayPropertiesDefinition
        + +
        +
        +

        The header for the interaction dialog.

        +
        +
        +
        +
        + +

        instructions

        +
        instructions: string
        + +
        +
        +

        The localized text telling the player what to do when they see this dialog.

        +
        +
        +
        +
        + +

        interactionIndex

        +
        interactionIndex: number
        + +
        +
        +

        The position of this interaction in its parent array. Note that this is NOT + content agnostic, and should not be used as such.

        +
        +
        +
        +
        + +

        interactionType

        +
        interactionType: VendorInteractionType
        + +
        +
        +

        The enumerated version of the possible UI hints for vendor interactions, which + is a little easier to grok than the hash found in uiInteractionType.

        +
        +
        +
        +
        + +

        questlineItemHash

        +
        questlineItemHash: number
        + +
        +
        +

        If this interaction dialog is about a quest, this is the questline related to + the interaction. You can use this to show the quest overview, or even the + character's status with the quest if you use it to find the character's current + Quest Step by checking their inventory against this questlineItemHash's + DestinyInventoryItemDefinition.setData.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        replies

        + + +
        +
        +

        The potential replies that the user can make to the interaction.

        +
        +
        +
        +
        + +

        rewardBlockLabel

        +
        rewardBlockLabel: string
        + +
        +
        +

        If this interaction is displaying rewards, this is the text to use for the + header of the reward-displaying section of the interaction.

        +
        +
        +
        +
        + +

        rewardVendorCategoryIndex

        +
        rewardVendorCategoryIndex: number
        + +
        +
        +

        If the vendor's reward list is sourced from one of his categories, this is the + index into the category array of items to show.

        +
        +
        +
        +
        + +

        sackInteractionList

        + + +
        +
        +

        If this interaction is meant to show you sacks, this is the list of types of + sacks to be shown. If empty, the interaction is not meant to show sacks.

        +
        +
        +
        +
        + +

        uiInteractionType

        +
        uiInteractionType: number
        + +
        +
        +

        A UI hint for the behavior of the interaction screen. This is useful to + determine what type of interaction is occurring, such as a prompt to receive a + rank up reward or a prompt to choose a reward for completing a quest. The hash + isn't as useful as the Enum in retrospect, well what can you do. Try using + interactionType instead.

        +
        +
        +
        +
        + +

        vendorCategoryIndex

        +
        vendorCategoryIndex: number
        + +
        +
        +

        If >= 0, this is the category of sale items to show along with this interaction + dialog.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorinteractionreplydefinition.html b/docs/interfaces/destinyvendorinteractionreplydefinition.html new file mode 100644 index 0000000..bab1093 --- /dev/null +++ b/docs/interfaces/destinyvendorinteractionreplydefinition.html @@ -0,0 +1,247 @@ + + + + + + DestinyVendorInteractionReplyDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorInteractionReplyDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        When the interaction is replied to, Reward sites will fire and items potentially + selected based on whether the given unlock expression is TRUE.

        +
        +

        You can potentially choose one from multiple replies when replying to an + interaction: this is how you get either/or rewards from vendors.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorInteractionReplyDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        itemRewardsSelection

        + + +
        +
        +

        The rewards granted upon responding to the vendor.

        +
        +
        +
        +
        + +

        reply

        +
        reply: string
        + +
        +
        +

        The localized text for the reply.

        +
        +
        +
        +
        + +

        replyType

        + + +
        +
        +

        An enum indicating the type of reply being made.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorinteractionsackentrydefinition.html b/docs/interfaces/destinyvendorinteractionsackentrydefinition.html new file mode 100644 index 0000000..5e46896 --- /dev/null +++ b/docs/interfaces/destinyvendorinteractionsackentrydefinition.html @@ -0,0 +1,203 @@ + + + + + + DestinyVendorInteractionSackEntryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorInteractionSackEntryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Compare this sackType to the sack identifier in the + DestinyInventoryItemDefinition.vendorSackType property of items. If they match, + show this sack with this interaction.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorInteractionSackEntryDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        sackType

        +
        sackType: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorinventoryflyoutbucketdefinition.html b/docs/interfaces/destinyvendorinventoryflyoutbucketdefinition.html new file mode 100644 index 0000000..81d78a6 --- /dev/null +++ b/docs/interfaces/destinyvendorinventoryflyoutbucketdefinition.html @@ -0,0 +1,246 @@ + + + + + + DestinyVendorInventoryFlyoutBucketDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorInventoryFlyoutBucketDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Information about a single inventory bucket in a vendor flyout UI and how it is + shown.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorInventoryFlyoutBucketDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        collapsible

        +
        collapsible: boolean
        + +
        +
        +

        If true, the inventory bucket should be able to be collapsed visually.

        +
        +
        +
        +
        + +

        inventoryBucketHash

        +
        inventoryBucketHash: number
        + +
        +
        +

        The inventory bucket whose contents should be shown.

        +
        +

        Mapped to DestinyInventoryBucketDefinition in the manifest.

        +
        +
        +
        + +

        sortItemsBy

        +
        sortItemsBy: DestinyItemSortType
        + +
        +
        +

        The methodology to use for sorting items from the flyout.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorinventoryflyoutdefinition.html b/docs/interfaces/destinyvendorinventoryflyoutdefinition.html new file mode 100644 index 0000000..8004503 --- /dev/null +++ b/docs/interfaces/destinyvendorinventoryflyoutdefinition.html @@ -0,0 +1,304 @@ + + + + + + DestinyVendorInventoryFlyoutDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorInventoryFlyoutDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The definition for an "inventory flyout": a UI screen where we show you part of + an otherwise hidden vendor inventory: like the Vault inventory buckets.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorInventoryFlyoutDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        buckets

        + + +
        +
        +

        A list of inventory buckets and other metadata to show on the screen.

        +
        +
        +
        +
        + +

        displayProperties

        + + +
        +
        +

        The title and other common properties of the flyout.

        +
        +
        +
        +
        + +

        Optional equipmentSlotHash

        +
        equipmentSlotHash: number
        + +
        +
        +

        If this flyout is meant to show you the contents of the player's equipment slot, + this is the slot to show.

        +
        +
        +
        +
        + +

        flyoutId

        +
        flyoutId: number
        + +
        +
        +

        An identifier for the flyout, in case anything else needs to refer to them.

        +
        +
        +
        +
        + +

        lockedDescription

        +
        lockedDescription: string
        + +
        +
        +

        If the flyout is locked, this is the reason why.

        +
        +
        +
        +
        + +

        suppressNewness

        +
        suppressNewness: boolean
        + +
        +
        +

        If this is true, don't show any of the glistening "this is a new item" UI + elements, like we show on the inventory items themselves in in-game UI.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendoritemdefinition.html b/docs/interfaces/destinyvendoritemdefinition.html new file mode 100644 index 0000000..912826f --- /dev/null +++ b/docs/interfaces/destinyvendoritemdefinition.html @@ -0,0 +1,687 @@ + + + + + + DestinyVendorItemDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorItemDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This represents an item being sold by the vendor.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorItemDefinition +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        action

        + + +
        +
        +

        The action to be performed when purchasing the item, if it's not just "buy".

        +
        +
        +
        +
        + +

        categoryIndex

        +
        categoryIndex: number
        + +
        +
        +

        The index into the DestinyVendorDefinition.categories array, so you can find the + category associated with this item.

        +
        +
        +
        +
        + +

        creationLevels

        + + +
        +
        +

        The Default level at which the item will spawn. Almost always driven by an + adjusto these days. Ideally should be singular. It's a long story how this ended + up as a list, but there is always either going to be 0:1 of these entities.

        +
        +
        +
        +
        + +

        currencies

        + + +
        +
        +

        This is a pre-compiled aggregation of item value and priceOverrideList, so that + we have one place to check for what the purchaser must pay for the item. Use + this instead of trying to piece together the price separately.

        +
        +

        The somewhat crappy part about this is that, now that item quantity overrides + have dynamic modifiers, this will not necessarily be statically true. If you + were using this instead of live data, switch to using live data.

        +
        +
        +
        + +

        displayCategory

        +
        displayCategory: string
        + +
        +
        +

        The string identifier for the category selling this item.

        +
        +
        +
        +
        + +

        displayCategoryIndex

        +
        displayCategoryIndex: number
        + +
        +
        +

        This is an index specifically into the display category, as opposed to the + server-side Categories (which do not need to match or pair with each other in + any way: server side categories are really just structures for common validation. + Display Category will let us more easily categorize items visually)

        +
        +
        +
        +
        + +

        exclusivity

        + + +
        +
        +

        If this item can only be purchased by a given platform, this indicates the + platform to which it is restricted.

        +
        +
        +
        +
        + +

        expirationTooltip

        +
        expirationTooltip: string
        + +
        +
        +

        If this item can expire, this is the tooltip message to show with its expiration + info.

        +
        +
        +
        +
        + +

        failureIndexes

        +
        failureIndexes: number[]
        + +
        +
        +

        An list of indexes into the DestinyVendorDefinition.failureStrings array, + indicating the possible failure strings that can be relevant for this item.

        +
        +
        +
        +
        + +

        inventoryBucketHash

        +
        inventoryBucketHash: number
        + +
        +
        +

        The inventory bucket into which this item will be placed upon purchase.

        +
        +
        +
        +
        + +

        Optional isCrm

        +
        isCrm: boolean
        + +
        +
        +

        If this sale can only be performed as the result of receiving a CRM offer, this + is true.

        +
        +
        +
        +
        + +

        Optional isOffer

        +
        isOffer: boolean
        + +
        +
        +

        If this sale can only be performed as the result of an offer check, this is true.

        +
        +
        +
        +
        + +

        itemHash

        +
        itemHash: number
        + +
        +
        +

        The hash identifier of the item being sold (DestinyInventoryItemDefinition).

        +
        +

        Note that a vendor can sell the same item in multiple ways, so don't assume that + itemHash is a unique identifier for this entity.

        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        maximumLevel

        +
        maximumLevel: number
        + +
        +
        +

        The maximum character level at which this item is available for sale.

        +
        +
        +
        +
        + +

        minimumLevel

        +
        minimumLevel: number
        + +
        +
        +

        The minimum character level at which this item is available for sale.

        +
        +
        +
        +
        + +

        originalCategoryIndex

        +
        originalCategoryIndex: number
        + +
        +
        +

        Same as above, but for the original category indexes.

        +
        +
        +
        +
        + +

        purchasableScope

        +
        purchasableScope: DestinyGatingScope
        + +
        +
        +

        Similar to visibilityScope, it represents the most restrictive scope that + determines whether the item can be purchased. It will at least be as restrictive + as visibilityScope, but could be more restrictive if the item has additional + purchase requirements beyond whether it is merely visible or not.

        +
        +

        See DestinyGatingScope's documentation for more information.

        +
        +
        +
        + +

        quantity

        +
        quantity: number
        + +
        +
        +

        The amount you will recieve of the item described in itemHash if you make the + purchase.

        +
        +
        +
        +
        + +

        redirectToSaleIndexes

        +
        redirectToSaleIndexes: number[]
        + +
        +
        +

        If this is populated, the purchase of this item should redirect to purchasing + these other items instead.

        +
        +
        +
        +
        + +

        refundPolicy

        + + +
        +
        +

        If this item can be refunded, this is the policy for what will be refundd, how, + and in what time period.

        +
        +
        +
        +
        + +

        refundTimeLimit

        +
        refundTimeLimit: number
        + +
        +
        +

        The amount of time before refundability of the newly purchased item will expire.

        +
        +
        +
        +
        + +

        socketOverrides

        + + +
        +
        + +

        sortValue

        +
        sortValue: number
        + +
        +
        +

        if the category this item is in supports non-default sorting, this value + should represent the sorting value to use, pre-processed and ready to go.

        +
        +
        +
        +
        + +

        vendorItemIndex

        +
        vendorItemIndex: number
        + +
        +
        +

        The index into the DestinyVendorDefinition.saleList. This is what we use to + refer to items being sold throughout live and definition data.

        +
        +
        +
        +
        + +

        visibilityScope

        +
        visibilityScope: DestinyGatingScope
        + +
        +
        +

        The most restrictive scope that determines whether the item is available in the + Vendor's inventory. See DestinyGatingScope's documentation for more information.

        +
        +

        This can be determined by Unlock gating, or by whether or not the item has + purchase level requirements (minimumLevel and maximumLevel properties).

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendoritemquantity.html b/docs/interfaces/destinyvendoritemquantity.html new file mode 100644 index 0000000..88158a4 --- /dev/null +++ b/docs/interfaces/destinyvendoritemquantity.html @@ -0,0 +1,251 @@ + + + + + + DestinyVendorItemQuantity | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorItemQuantity

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        In addition to item quantity information for vendor prices, this also has any + optional information that may exist about how the item's quantity can be + modified. (unfortunately not information that is able to be read outside of the + BNet servers, but it's there)

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorItemQuantity +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        itemHash

        +
        itemHash: number
        + +
        +
        +

        The hash identifier for the item in question. Use it to look up the item's + DestinyInventoryItemDefinition.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        Optional itemInstanceId

        +
        itemInstanceId: string
        + +
        +
        +

        If this quantity is referring to a specific instance of an item, this will have + the item's instance ID. Normally, this will be null.

        +
        +
        +
        +
        + +

        quantity

        +
        quantity: number
        + +
        +
        +

        The amount of the item needed/available depending on the context of where + DestinyItemQuantity is being used.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendoritemsocketoverride.html b/docs/interfaces/destinyvendoritemsocketoverride.html new file mode 100644 index 0000000..c86da06 --- /dev/null +++ b/docs/interfaces/destinyvendoritemsocketoverride.html @@ -0,0 +1,252 @@ + + + + + + DestinyVendorItemSocketOverride | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorItemSocketOverride

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The information for how the vendor purchase should override a given socket with + custom plug data.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorItemSocketOverride +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        randomizedOptionsCount

        +
        randomizedOptionsCount: number
        + +
        +
        +

        If this is greater than -1, the number of randomized plugs on this socket will + be set to this quantity instead of whatever it's set to by default.

        +
        +
        +
        +
        + +

        Optional singleItemHash

        +
        singleItemHash: number
        + +
        +
        +

        If this is populated, the socket will be overridden with a specific plug.

        +
        +

        If this isn't populated, it's being overridden by something more complicated + that is only known by the Game Server and God, which means we can't tell you in + advance what it'll be.

        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        socketTypeHash

        +
        socketTypeHash: number
        + +
        +
        +

        This appears to be used to select which socket ultimately gets the override + defined here.

        +
        +

        Mapped to DestinySocketTypeDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorlocationdefinition.html b/docs/interfaces/destinyvendorlocationdefinition.html new file mode 100644 index 0000000..b63ca24 --- /dev/null +++ b/docs/interfaces/destinyvendorlocationdefinition.html @@ -0,0 +1,229 @@ + + + + + + DestinyVendorLocationDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorLocationDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        These definitions represent vendors' locations and relevant display information + at different times in the game.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorLocationDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        backgroundImagePath

        +
        backgroundImagePath: string
        + +
        +
        +

        The relative path to the background image representing this Vendor at this + location, for use in a banner.

        +
        +
        +
        +
        + +

        destinationHash

        +
        destinationHash: number
        + +
        +
        +

        The hash identifier for a Destination at which this vendor may be located. Each + destination where a Vendor may exist will only ever have a single entry.

        +
        +

        Mapped to DestinyDestinationDefinition in the manifest.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorreceipt.html b/docs/interfaces/destinyvendorreceipt.html new file mode 100644 index 0000000..672382b --- /dev/null +++ b/docs/interfaces/destinyvendorreceipt.html @@ -0,0 +1,344 @@ + + + + + + DestinyVendorReceipt | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorReceipt

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        If a character purchased an item that is refundable, a Vendor Receipt will be + created on the user's Destiny Profile. These expire after a configurable period + of time, but until then can be used to get refunds on items. BNet does not + provide the ability to refund a purchase yet, but you know.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorReceipt +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        currencyPaid

        +
        currencyPaid: DestinyItemQuantity[]
        + +
        +
        +

        The amount paid for the item, in terms of items that were consumed in the + purchase and their quantity.

        +
        +
        +
        +
        + +

        expiresOn

        +
        expiresOn: string
        + +
        +
        +

        The date at which this receipt is rendered invalid.

        +
        +
        +
        +
        + +

        itemReceived

        +
        itemReceived: DestinyItemQuantity
        + +
        +
        +

        The item that was received, and its quantity.

        +
        +
        +
        +
        + +

        licenseUnlockHash

        +
        licenseUnlockHash: number
        + +
        +
        +

        The unlock flag used to determine whether you still have the purchased item.

        +
        +
        +
        +
        + +

        purchasedByCharacterId

        +
        purchasedByCharacterId: string
        + +
        +
        +

        The ID of the character who made the purchase.

        +
        +
        +
        +
        + +

        refundPolicy

        + + +
        +
        +

        Whether you can get a refund, and what happens in order for the refund to be + received. See the DestinyVendorItemRefundPolicy enum for details.

        +
        +
        +
        +
        + +

        sequenceNumber

        +
        sequenceNumber: number
        + +
        +
        +

        The identifier of this receipt.

        +
        +
        +
        +
        + +

        timeToExpiration

        +
        timeToExpiration: string
        + +
        +
        +

        The seconds since epoch at which this receipt is rendered invalid.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorreceiptscomponent.html b/docs/interfaces/destinyvendorreceiptscomponent.html new file mode 100644 index 0000000..ebdeb5b --- /dev/null +++ b/docs/interfaces/destinyvendorreceiptscomponent.html @@ -0,0 +1,208 @@ + + + + + + DestinyVendorReceiptsComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorReceiptsComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        For now, this isn't used for much: it's a record of the recent refundable + purchases that the user has made. In the future, it could be used for providing + refunds/buyback via the API. Wouldn't that be fun?

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorReceiptsComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        receipts

        + + +
        +
        +

        The receipts for refundable purchases made at a vendor.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorrequirementdisplayentrydefinition.html b/docs/interfaces/destinyvendorrequirementdisplayentrydefinition.html new file mode 100644 index 0000000..c3c2eab --- /dev/null +++ b/docs/interfaces/destinyvendorrequirementdisplayentrydefinition.html @@ -0,0 +1,244 @@ + + + + + + DestinyVendorRequirementDisplayEntryDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorRequirementDisplayEntryDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The localized properties of the requirementsDisplay, allowing information about + the requirement or item being featured to be seen.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorRequirementDisplayEntryDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        icon

        +
        icon: string
        + +
        +
        + +

        name

        +
        name: string
        + +
        +
        + +

        source

        +
        source: string
        + +
        +
        + +

        type

        +
        type: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorresponse.html b/docs/interfaces/destinyvendorresponse.html new file mode 100644 index 0000000..b812adc --- /dev/null +++ b/docs/interfaces/destinyvendorresponse.html @@ -0,0 +1,289 @@ + + + + + + DestinyVendorResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorResponse

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A response containing all of the components for a vendor.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        categories

        + + +
        +
        +

        Categories that the vendor has available, and references to the sales therein.

        +
        +

        COMPONENT TYPE: VendorCategories

        +
        +
        +
        + +

        currencyLookups

        + + +
        +
        +

        A "lookup" convenience component that can be used to quickly check if the + character has access to items that can be used for purchasing.

        +
        +

        COMPONENT TYPE: CurrencyLookups

        +
        +
        +
        + +

        itemComponents

        + + +
        +
        +

        Item components, keyed by the vendorItemIndex of the active sale items.

        +
        +

        COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component + types.]

        +
        +
        +
        + +

        sales

        + + +
        +
        +

        Sales, keyed by the vendorItemIndex of the item being sold.

        +
        +

        COMPONENT TYPE: VendorSales

        +
        +
        +
        + +

        vendor

        + + +
        +
        +

        The base properties of the vendor.

        +
        +

        COMPONENT TYPE: Vendors

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorsaleitemactionblockdefinition.html b/docs/interfaces/destinyvendorsaleitemactionblockdefinition.html new file mode 100644 index 0000000..3aaf3da --- /dev/null +++ b/docs/interfaces/destinyvendorsaleitemactionblockdefinition.html @@ -0,0 +1,215 @@ + + + + + + DestinyVendorSaleItemActionBlockDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorSaleItemActionBlockDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Not terribly useful, some basic cooldown interaction info.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorSaleItemActionBlockDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        executeSeconds

        +
        executeSeconds: number
        + +
        +
        + +

        isPositive

        +
        isPositive: boolean
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorsaleitemcomponent.html b/docs/interfaces/destinyvendorsaleitemcomponent.html new file mode 100644 index 0000000..7053f27 --- /dev/null +++ b/docs/interfaces/destinyvendorsaleitemcomponent.html @@ -0,0 +1,444 @@ + + + + + + DestinyVendorSaleItemComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorSaleItemComponent

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Request this component if you want the details about an item being sold in + relation to the character making the request: whether the character can buy it, + whether they can afford it, and other data related to purchasing the item.

        +
        +

        Note that if you want instance, stats, etc... data for the item, you'll have to + request additional components such as ItemInstances, ItemPerks etc... and + acquire them from the DestinyVendorResponse's "items" property.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorSaleItemComponent +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        augments

        + + +
        +
        +

        A flags enumeration value representing the current state of any "state modifiers" + on the item being sold. These are meant to correspond with some sort of visual + indicator as to the augmentation: for instance, if an item is on sale or if you + already own the item in question.

        +
        +

        Determining how you want to represent these in your own app (or if you even want + to) is an exercise left for the reader.

        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        + +

        costs

        + + +
        +
        +

        A summary of the current costs of the item.

        +
        +
        +
        +
        + +

        failureIndexes

        +
        failureIndexes: number[]
        + +
        +
        +

        Indexes in to the "failureStrings" lookup table in DestinyVendorDefinition for + the given Vendor. Gives some more reliable failure information for why you can't + purchase an item.

        +
        +

        It is preferred to use these over requiredUnlocks and unlockStatuses: the latter + are provided mostly in case someone can do something interesting with it that I + didn't anticipate.

        +
        +
        +
        + +

        itemHash

        +
        itemHash: number
        + +
        +
        +

        The hash of the item being sold, as a quick shortcut for looking up the + DestinyInventoryItemDefinition of the sale item.

        +
        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        Optional overrideNextRefreshDate

        +
        overrideNextRefreshDate: string
        + +
        +
        +

        If this item has its own custom date where it may be removed from the Vendor's + rotation, this is that date.

        +
        +

        Note that there's not actually any guarantee that it will go away: it could be + chosen again and end up still being in the Vendor's sale items! But this is the + next date where that test will occur, and is also the date that the game shows + for availability on things like Bounties being sold. So it's the best we can + give.

        +
        +
        +
        + +

        Optional overrideStyleItemHash

        +
        overrideStyleItemHash: number
        + +
        +
        +

        If populated, this is the hash of the item whose icon (and other secondary + styles, but not the human readable strings) should override whatever icons/ + styles are on the item being sold.

        +
        +

        If you don't do this, certain items whose styles are being overridden by + socketed items - such as the "Recycle Shader" item - would show whatever their + default icon/style is, and it wouldn't be pretty or look accurate.

        +

        Mapped to DestinyInventoryItemDefinition in the manifest.

        +
        +
        +
        + +

        quantity

        +
        quantity: number
        + +
        +
        +

        How much of the item you'll be getting.

        +
        +
        +
        +
        + +

        requiredUnlocks

        +
        requiredUnlocks: number[]
        + +
        +
        +

        If you can't buy the item due to a complex character state, these will be hashes + for DestinyUnlockDefinitions that you can check to see messages regarding the + failure (if the unlocks have human readable information: it is not guaranteed + that Unlocks will have human readable strings, and your application will have to + handle that)

        +
        +

        Prefer using failureIndexes instead. These are provided for informational + purposes, but have largely been supplanted by failureIndexes.

        +

        Mapped to DestinyUnlockDefinition in the manifest.

        +
        +
        +
        + +

        saleStatus

        +
        saleStatus: VendorItemStatus
        + +
        +
        +

        A flag indicating whether the requesting character can buy the item, and if not + the reasons why the character can't buy it.

        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        + +

        unlockStatuses

        +
        unlockStatuses: DestinyUnlockStatus[]
        + +
        +
        +

        If any complex unlock states are checked in determining purchasability, these + will be returned here along with the status of the unlock check.

        +
        +

        Prefer using failureIndexes instead. These are provided for informational + purposes, but have largely been supplanted by failureIndexes.

        +
        +
        +
        + +

        vendorItemIndex

        +
        vendorItemIndex: number
        + +
        +
        +

        The index into the DestinyVendorDefinition.itemList property. Note that this + means Vendor data is Content Version dependent: make sure you have the latest + content before you use Vendor data, or these indexes may mismatch.

        +
        +

        Most systems avoid this problem, but Vendors is one area where we are unable to + reasonably avoid content dependency at the moment.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorservicedefinition.html b/docs/interfaces/destinyvendorservicedefinition.html new file mode 100644 index 0000000..f40aea2 --- /dev/null +++ b/docs/interfaces/destinyvendorservicedefinition.html @@ -0,0 +1,206 @@ + + + + + + DestinyVendorServiceDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorServiceDefinition

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        When a vendor provides services, this is the localized name of those services.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorServiceDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        name

        +
        name: string
        + +
        +
        +

        The localized name of a service provided.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/destinyvendorsresponse.html b/docs/interfaces/destinyvendorsresponse.html new file mode 100644 index 0000000..f52296b --- /dev/null +++ b/docs/interfaces/destinyvendorsresponse.html @@ -0,0 +1,329 @@ + + + + + + DestinyVendorsResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DestinyVendorsResponse

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A response containing all of the components for all requested vendors.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DestinyVendorsResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        categories

        + + +
        +
        +

        Categories that the vendor has available, and references to the sales therein. + These are keyed by the Vendor Hash, so you will get one Categories Component per + vendor returned.

        +
        +

        COMPONENT TYPE: VendorCategories

        +
        +
        +
        + +

        currencyLookups

        + + +
        +
        +

        A "lookup" convenience component that can be used to quickly check if the + character has access to items that can be used for purchasing.

        +
        +

        COMPONENT TYPE: CurrencyLookups

        +
        +
        +
        + +

        itemComponents

        +
        itemComponents: object
        + +
        +
        +

        The set of item detail components, one set of item components per Vendor. These + are keyed by the Vendor Hash, so you will get one Item Component Set per vendor + returned.

        +
        +

        The components contained inside are themselves keyed by the vendorSaleIndex, and + will have whatever item-level components you requested (Sockets, Stats, Instance + data etc...) per item being sold by the vendor.

        +
        +
        +

        Type declaration

        + +
        +
        +
        + +

        sales

        + + +
        +
        +

        Sales, keyed by the vendorItemIndex of the item being sold. These are keyed by + the Vendor Hash, so you will get one Sale Item Set Component per vendor returned.

        +
        +

        Note that within the Sale Item Set component, the sales are themselves keyed by + the vendorSaleIndex, so you can relate it to the corrent sale item definition + within the Vendor's definition.

        +

        COMPONENT TYPE: VendorSales

        +
        +
        +
        + +

        vendorGroups

        + + +
        +
        +

        For Vendors being returned, this will give you the information you need to group + them and order them in the same way that the Bungie Companion app performs + grouping. It will automatically be returned if you request the Vendors component.

        +
        +

        COMPONENT TYPE: Vendors

        +
        +
        +
        + +

        vendors

        + + +
        +
        +

        The base properties of the vendor. These are keyed by the Vendor Hash, so you + will get one Vendor Component per vendor returned.

        +
        +

        COMPONENT TYPE: Vendors

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/dictionarycomponentresponse.html b/docs/interfaces/dictionarycomponentresponse.html new file mode 100644 index 0000000..2cd8724 --- /dev/null +++ b/docs/interfaces/dictionarycomponentresponse.html @@ -0,0 +1,224 @@ + + + + + + DictionaryComponentResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DictionaryComponentResponse<T>

        +
        +
        +
        +
        +
        +
        +
        +

        Type parameters

        +
          +
        • +

          T

          +
        • +
        +
        +
        +

        Hierarchy

        +
          +
        • + DictionaryComponentResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        data

        +
        data: object
        + +
        +

        Type declaration

        +
          +
        • +
          [key: string]: T
          +
        • +
        +
        +
        +
        + +

        privacy

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/dictionaryresponse.html b/docs/interfaces/dictionaryresponse.html new file mode 100644 index 0000000..f0ceb61 --- /dev/null +++ b/docs/interfaces/dictionaryresponse.html @@ -0,0 +1,175 @@ + + + + + + DictionaryResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DictionaryResponse<S>

        +
        +
        +
        +
        +
        +
        +
        +

        Type parameters

        +
          +
        • +

          S

          +
        • +
        +
        +
        +

        Hierarchy

        +
          +
        • + DictionaryResponse +
        • +
        +
        +
        +

        Indexable

        +
        [key: string]: S
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/dyereference.html b/docs/interfaces/dyereference.html new file mode 100644 index 0000000..213295e --- /dev/null +++ b/docs/interfaces/dyereference.html @@ -0,0 +1,208 @@ + + + + + + DyeReference | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface DyeReference

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + DyeReference +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        channelHash

        +
        channelHash: number
        + +
        +
        + +

        dyeHash

        +
        dyeHash: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/entityactionresult.html b/docs/interfaces/entityactionresult.html new file mode 100644 index 0000000..72b9a86 --- /dev/null +++ b/docs/interfaces/entityactionresult.html @@ -0,0 +1,208 @@ + + + + + + EntityActionResult | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface EntityActionResult

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + EntityActionResult +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        entityId

        +
        entityId: string
        + +
        +
        + +

        result

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/fireteammember.html b/docs/interfaces/fireteammember.html new file mode 100644 index 0000000..368e5b7 --- /dev/null +++ b/docs/interfaces/fireteammember.html @@ -0,0 +1,278 @@ + + + + + + FireteamMember | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface FireteamMember

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + FireteamMember +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        bungieNetUserInfo

        +
        bungieNetUserInfo: UserInfoCard
        + +
        +
        + +

        characterId

        +
        characterId: string
        + +
        +
        + +

        dateJoined

        +
        dateJoined: string
        + +
        +
        + +

        destinyUserInfo

        +
        destinyUserInfo: UserInfoCard
        + +
        +
        + +

        hasMicrophone

        +
        hasMicrophone: boolean
        + +
        +
        + +

        lastPlatformInviteAttemptDate

        +
        lastPlatformInviteAttemptDate: string
        + +
        +
        + +

        lastPlatformInviteAttemptResult

        +
        lastPlatformInviteAttemptResult: FireteamPlatformInviteResult
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/fireteamresponse.html b/docs/interfaces/fireteamresponse.html new file mode 100644 index 0000000..99e0c40 --- /dev/null +++ b/docs/interfaces/fireteamresponse.html @@ -0,0 +1,222 @@ + + + + + + FireteamResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface FireteamResponse

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + FireteamResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        Alternates

        +
        Alternates: FireteamMember[]
        + +
        +
        + +

        Members

        +
        Members: FireteamMember[]
        + +
        +
        + +

        Summary

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/fireteamsummary.html b/docs/interfaces/fireteamsummary.html new file mode 100644 index 0000000..8ee6941 --- /dev/null +++ b/docs/interfaces/fireteamsummary.html @@ -0,0 +1,432 @@ + + + + + + FireteamSummary | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface FireteamSummary

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + FireteamSummary +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        activityType

        +
        activityType: FireteamActivityType
        + +
        +
        + +

        Optional alternateSlotCount

        +
        alternateSlotCount: number
        + +
        +
        + +

        availableAlternateSlotCount

        +
        availableAlternateSlotCount: number
        + +
        +
        + +

        availablePlayerSlotCount

        +
        availablePlayerSlotCount: number
        + +
        +
        + +

        dateCreated

        +
        dateCreated: string
        + +
        +
        + +

        Optional dateModified

        +
        dateModified: string
        + +
        +
        + +

        datePlayerModified

        +
        datePlayerModified: string
        + +
        +
        + +

        fireteamId

        +
        fireteamId: string
        + +
        +
        + +

        groupId

        +
        groupId: string
        + +
        +
        + +

        isImmediate

        +
        isImmediate: boolean
        + +
        +
        + +

        isPublic

        +
        isPublic: boolean
        + +
        +
        + +

        isValid

        +
        isValid: boolean
        + +
        +
        + +

        locale

        +
        locale: string
        + +
        +
        + +

        ownerMembershipId

        +
        ownerMembershipId: string
        + +
        +
        + +

        platform

        + + +
        +
        + +

        playerSlotCount

        +
        playerSlotCount: number
        + +
        +
        + +

        Optional scheduledTime

        +
        scheduledTime: string
        + +
        +
        + +

        title

        +
        title: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/forumrecruitmentdetail.html b/docs/interfaces/forumrecruitmentdetail.html new file mode 100644 index 0000000..bf8978f --- /dev/null +++ b/docs/interfaces/forumrecruitmentdetail.html @@ -0,0 +1,320 @@ + + + + + + ForumRecruitmentDetail | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface ForumRecruitmentDetail

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + ForumRecruitmentDetail +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        Fireteam

        +
        Fireteam: GeneralUser[]
        + +
        +
        + +

        approved

        +
        approved: boolean
        + +
        +
        + +

        Optional conversationId

        +
        conversationId: string
        + +
        +
        + +

        intensity

        + + +
        +
        + +

        kickedPlayerIds

        +
        kickedPlayerIds: string[]
        + +
        +
        + +

        microphoneRequired

        +
        microphoneRequired: boolean
        + +
        +
        + +

        playerSlotsRemaining

        +
        playerSlotsRemaining: number
        + +
        +
        + +

        playerSlotsTotal

        +
        playerSlotsTotal: number
        + +
        +
        + +

        tone

        + + +
        +
        + +

        topicId

        +
        topicId: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/gearassetdatabasedefinition.html b/docs/interfaces/gearassetdatabasedefinition.html new file mode 100644 index 0000000..b713c6d --- /dev/null +++ b/docs/interfaces/gearassetdatabasedefinition.html @@ -0,0 +1,208 @@ + + + + + + GearAssetDataBaseDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GearAssetDataBaseDefinition

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GearAssetDataBaseDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        path

        +
        path: string
        + +
        +
        + +

        version

        +
        version: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/generaluser.html b/docs/interfaces/generaluser.html new file mode 100644 index 0000000..0794800 --- /dev/null +++ b/docs/interfaces/generaluser.html @@ -0,0 +1,600 @@ + + + + + + GeneralUser | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GeneralUser

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GeneralUser +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        about

        +
        about: string
        + +
        +
        + +

        blizzardDisplayName

        +
        blizzardDisplayName: string
        + +
        +
        + +

        context

        + + +
        +
        + +

        displayName

        +
        displayName: string
        + +
        +
        + +

        fbDisplayName

        +
        fbDisplayName: string
        + +
        +
        + +

        Optional firstAccess

        +
        firstAccess: string
        + +
        +
        + +

        isDeleted

        +
        isDeleted: boolean
        + +
        +
        + +

        Optional lastBanReportId

        +
        lastBanReportId: string
        + +
        +
        + +

        Optional lastUpdate

        +
        lastUpdate: string
        + +
        +
        + +

        Optional legacyPortalUID

        +
        legacyPortalUID: string
        + +
        +
        + +

        locale

        +
        locale: string
        + +
        +
        + +

        localeInheritDefault

        +
        localeInheritDefault: boolean
        + +
        +
        + +

        membershipId

        +
        membershipId: string
        + +
        +
        + +

        normalizedName

        +
        normalizedName: string
        + +
        +
        + +

        Optional profileBanExpire

        +
        profileBanExpire: string
        + +
        +
        + +

        profilePicture

        +
        profilePicture: number
        + +
        +
        + +

        profilePicturePath

        +
        profilePicturePath: string
        + +
        +
        + +

        profilePictureWidePath

        +
        profilePictureWidePath: string
        + +
        +
        + +

        profileTheme

        +
        profileTheme: number
        + +
        +
        + +

        profileThemeName

        +
        profileThemeName: string
        + +
        +
        + +

        psnDisplayName

        +
        psnDisplayName: string
        + +
        +
        + +

        Optional showActivity

        +
        showActivity: boolean
        + +
        +
        + +

        showGroupMessaging

        +
        showGroupMessaging: boolean
        + +
        +
        + +

        statusDate

        +
        statusDate: string
        + +
        +
        + +

        statusText

        +
        statusText: string
        + +
        +
        + +

        successMessageFlags

        +
        successMessageFlags: string
        + +
        +
        + +

        uniqueName

        +
        uniqueName: string
        + +
        +
        + +

        userTitle

        +
        userTitle: number
        + +
        +
        + +

        userTitleDisplay

        +
        userTitleDisplay: string
        + +
        +
        + +

        xboxDisplayName

        +
        xboxDisplayName: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/globalalert.html b/docs/interfaces/globalalert.html new file mode 100644 index 0000000..13faa81 --- /dev/null +++ b/docs/interfaces/globalalert.html @@ -0,0 +1,278 @@ + + + + + + GlobalAlert | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GlobalAlert

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GlobalAlert +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        AlerTimestamp

        +
        AlerTimestamp: Date
        + +
        +
        + +

        AlertHtml

        +
        AlertHtml: string
        + +
        +
        + +

        AlertKey

        +
        AlertKey: string
        + +
        +
        + +

        AlertLevel

        +
        AlertLevel: GlobalAlertLevel
        + +
        +
        + +

        AlertLink

        +
        AlertLink: string
        + +
        +
        + +

        AlertType

        +
        AlertType: GlobalAlertType
        + +
        +
        + +

        StreamInfo

        +
        StreamInfo: StreamInfo
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupapplicationlistrequest.html b/docs/interfaces/groupapplicationlistrequest.html new file mode 100644 index 0000000..a763fd8 --- /dev/null +++ b/docs/interfaces/groupapplicationlistrequest.html @@ -0,0 +1,208 @@ + + + + + + GroupApplicationListRequest | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupApplicationListRequest

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupApplicationListRequest +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        memberships

        +
        memberships: UserMembership[]
        + +
        +
        + +

        message

        +
        message: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupapplicationrequest.html b/docs/interfaces/groupapplicationrequest.html new file mode 100644 index 0000000..4a9ebb9 --- /dev/null +++ b/docs/interfaces/groupapplicationrequest.html @@ -0,0 +1,194 @@ + + + + + + GroupApplicationRequest | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupApplicationRequest

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupApplicationRequest +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        message

        +
        message: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupapplicationresponse.html b/docs/interfaces/groupapplicationresponse.html new file mode 100644 index 0000000..b5766ec --- /dev/null +++ b/docs/interfaces/groupapplicationresponse.html @@ -0,0 +1,194 @@ + + + + + + GroupApplicationResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupApplicationResponse

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupApplicationResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        resolution

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupban.html b/docs/interfaces/groupban.html new file mode 100644 index 0000000..f2d67b3 --- /dev/null +++ b/docs/interfaces/groupban.html @@ -0,0 +1,292 @@ + + + + + + GroupBan | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupBan

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupBan +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        bungieNetUserInfo

        +
        bungieNetUserInfo: UserInfoCard
        + +
        +
        + +

        comment

        +
        comment: string
        + +
        +
        + +

        createdBy

        +
        createdBy: UserInfoCard
        + +
        +
        + +

        dateBanned

        +
        dateBanned: string
        + +
        +
        + +

        dateExpires

        +
        dateExpires: string
        + +
        +
        + +

        destinyUserInfo

        +
        destinyUserInfo: UserInfoCard
        + +
        +
        + +

        groupId

        +
        groupId: string
        + +
        +
        + +

        lastModifiedBy

        +
        lastModifiedBy: UserInfoCard
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupbanrequest.html b/docs/interfaces/groupbanrequest.html new file mode 100644 index 0000000..4eea243 --- /dev/null +++ b/docs/interfaces/groupbanrequest.html @@ -0,0 +1,208 @@ + + + + + + GroupBanRequest | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupBanRequest

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupBanRequest +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        comment

        +
        comment: string
        + +
        +
        + +

        length

        +
        length: IgnoreLength
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupeditaction.html b/docs/interfaces/groupeditaction.html new file mode 100644 index 0000000..6c18804 --- /dev/null +++ b/docs/interfaces/groupeditaction.html @@ -0,0 +1,404 @@ + + + + + + GroupEditAction | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupEditAction

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupEditAction +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        about

        +
        about: string
        + +
        +
        + +

        Optional allowChat

        +
        allowChat: boolean
        + +
        +
        + +

        Optional avatarImageIndex

        +
        avatarImageIndex: number
        + +
        +
        + +

        callsign

        +
        callsign: string
        + +
        +
        + +

        Optional chatSecurity

        +
        chatSecurity: number
        + +
        +
        + +

        Optional defaultPublicity

        +
        defaultPublicity: number
        + +
        +
        + +

        Optional enableInvitationMessagingForAdmins

        +
        enableInvitationMessagingForAdmins: boolean
        + +
        +
        + +

        Optional homepage

        +
        homepage: number
        + +
        +
        + +

        Optional isPublic

        +
        isPublic: boolean
        + +
        +
        + +

        Optional isPublicTopicAdminOnly

        +
        isPublicTopicAdminOnly: boolean
        + +
        +
        + +

        locale

        +
        locale: string
        + +
        +
        + +

        Optional membershipOption

        +
        membershipOption: number
        + +
        +
        + +

        motto

        +
        motto: string
        + +
        +
        + +

        name

        +
        name: string
        + +
        +
        + +

        tags

        +
        tags: string
        + +
        +
        + +

        theme

        +
        theme: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupfeatures.html b/docs/interfaces/groupfeatures.html new file mode 100644 index 0000000..6060fd6 --- /dev/null +++ b/docs/interfaces/groupfeatures.html @@ -0,0 +1,359 @@ + + + + + + GroupFeatures | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupFeatures

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupFeatures +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        capabilities

        +
        capabilities: Capabilities
        + +
        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        +
        + +

        hostGuidedGamePermissionOverride

        +
        hostGuidedGamePermissionOverride: HostGuidedGamesPermissionLevel
        + +
        +
        +

        Minimum Member Level allowed to host guided games

        +
        +

        Always Allowed: Founder, Acting Founder, Admin

        +

        Allowed Overrides: None, Member, Beginner

        +

        Default is Member for clans, None for groups, although this means nothing for + groups.

        +
        +
        +
        + +

        invitePermissionOverride

        +
        invitePermissionOverride: boolean
        + +
        +
        +

        Minimum Member Level allowed to invite new members to group

        +
        +

        Always Allowed: Founder, Acting Founder

        +

        True means admins have this power, false means they don't

        +

        Default is false for clans, true for groups.

        +
        +
        +
        + +

        joinLevel

        + + +
        +
        +

        Level to join a member at when accepting an invite, application, or joining an + open clan

        +
        +

        Default is Beginner.

        +
        +
        +
        + +

        maximumMembers

        +
        maximumMembers: number
        + +
        +
        + +

        maximumMembershipsOfGroupType

        +
        maximumMembershipsOfGroupType: number
        + +
        +
        +

        Maximum number of groups of this type a typical membership may join. For example, + a user may join about 50 General groups with their Bungie.net account. They may + join one clan per Destiny membership.

        +
        +
        +
        +
        + +

        membershipTypes

        +
        membershipTypes: BungieMembershipType[]
        + +
        +
        + +

        updateBannerPermissionOverride

        +
        updateBannerPermissionOverride: boolean
        + +
        +
        +

        Minimum Member Level allowed to update banner

        +
        +

        Always Allowed: Founder, Acting Founder

        +

        True means admins have this power, false means they don't

        +

        Default is false for clans, true for groups.

        +
        +
        +
        + +

        updateCulturePermissionOverride

        +
        updateCulturePermissionOverride: boolean
        + +
        +
        +

        Minimum Member Level allowed to update group culture

        +
        +

        Always Allowed: Founder, Acting Founder

        +

        True means admins have this power, false means they don't

        +

        Default is false for clans, true for groups.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupmember.html b/docs/interfaces/groupmember.html new file mode 100644 index 0000000..de70556 --- /dev/null +++ b/docs/interfaces/groupmember.html @@ -0,0 +1,278 @@ + + + + + + GroupMember | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupMember

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupMember +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        bungieNetUserInfo

        +
        bungieNetUserInfo: UserInfoCard
        + +
        +
        + +

        destinyUserInfo

        +
        destinyUserInfo: UserInfoCard
        + +
        +
        + +

        groupId

        +
        groupId: string
        + +
        +
        + +

        isOnline

        +
        isOnline: boolean
        + +
        +
        + +

        joinDate

        +
        joinDate: string
        + +
        +
        + +

        lastOnlineStatusChange

        +
        lastOnlineStatusChange: string
        + +
        +
        + +

        memberType

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupmemberapplication.html b/docs/interfaces/groupmemberapplication.html new file mode 100644 index 0000000..18c1386 --- /dev/null +++ b/docs/interfaces/groupmemberapplication.html @@ -0,0 +1,306 @@ + + + + + + GroupMemberApplication | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupMemberApplication

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupMemberApplication +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        bungieNetUserInfo

        +
        bungieNetUserInfo: UserInfoCard
        + +
        +
        + +

        creationDate

        +
        creationDate: string
        + +
        +
        + +

        destinyUserInfo

        +
        destinyUserInfo: UserInfoCard
        + +
        +
        + +

        groupId

        +
        groupId: string
        + +
        +
        + +

        requestMessage

        +
        requestMessage: string
        + +
        +
        + +

        Optional resolveDate

        +
        resolveDate: string
        + +
        +
        + +

        resolveMessage

        +
        resolveMessage: string
        + +
        +
        + +

        resolveState

        + + +
        +
        + +

        Optional resolvedByMembershipId

        +
        resolvedByMembershipId: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupmemberleaveresult.html b/docs/interfaces/groupmemberleaveresult.html new file mode 100644 index 0000000..ec4c229 --- /dev/null +++ b/docs/interfaces/groupmemberleaveresult.html @@ -0,0 +1,208 @@ + + + + + + GroupMemberLeaveResult | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupMemberLeaveResult

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupMemberLeaveResult +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        group

        +
        group: GroupV2
        + +
        +
        + +

        groupDeleted

        +
        groupDeleted: boolean
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupmembership.html b/docs/interfaces/groupmembership.html new file mode 100644 index 0000000..768742e --- /dev/null +++ b/docs/interfaces/groupmembership.html @@ -0,0 +1,208 @@ + + + + + + GroupMembership | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupMembership

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupMembership +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        group

        +
        group: GroupV2
        + +
        +
        + +

        member

        +
        member: GroupMember
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupmembershipsearchresponse.html b/docs/interfaces/groupmembershipsearchresponse.html new file mode 100644 index 0000000..f3a1c27 --- /dev/null +++ b/docs/interfaces/groupmembershipsearchresponse.html @@ -0,0 +1,275 @@ + + + + + + GroupMembershipSearchResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupMembershipSearchResponse

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupMembershipSearchResponse +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        hasMore

        +
        hasMore: boolean
        + +
        +
        + +

        query

        +
        query: PagedQuery
        + +
        +
        + +

        replacementContinuationToken

        +
        replacementContinuationToken: string
        + +
        +
        + +

        results

        +
        results: GroupMembership[]
        + +
        +
        + +

        totalResults

        +
        totalResults: number
        + +
        +
        + +

        useTotalResults

        +
        useTotalResults: boolean
        + +
        +
        +

        If useTotalResults is true, then totalResults represents an accurate count.

        +
        +

        If False, it does not, and may be estimated/only the size of the current page.

        +

        Either way, you should probably always only trust hasMore.

        +

        This is a long-held historical throwback to when we used to do paging with known + total results. Those queries toasted our database, and we were left to hastily + alter our endpoints and create backward- compatible shims, of which + useTotalResults is one.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupnamesearchrequest.html b/docs/interfaces/groupnamesearchrequest.html new file mode 100644 index 0000000..6d4d215 --- /dev/null +++ b/docs/interfaces/groupnamesearchrequest.html @@ -0,0 +1,208 @@ + + + + + + GroupNameSearchRequest | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupNameSearchRequest

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupNameSearchRequest +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        groupName

        +
        groupName: string
        + +
        +
        + +

        groupType

        +
        groupType: GroupType
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupoptionalconversation.html b/docs/interfaces/groupoptionalconversation.html new file mode 100644 index 0000000..3ee5f66 --- /dev/null +++ b/docs/interfaces/groupoptionalconversation.html @@ -0,0 +1,250 @@ + + + + + + GroupOptionalConversation | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupOptionalConversation

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupOptionalConversation +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        chatEnabled

        +
        chatEnabled: boolean
        + +
        +
        + +

        chatName

        +
        chatName: string
        + +
        +
        + +

        chatSecurity

        +
        chatSecurity: ChatSecuritySetting
        + +
        +
        + +

        conversationId

        +
        conversationId: string
        + +
        +
        + +

        groupId

        +
        groupId: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupoptionalconversationaddrequest.html b/docs/interfaces/groupoptionalconversationaddrequest.html new file mode 100644 index 0000000..cc31e8a --- /dev/null +++ b/docs/interfaces/groupoptionalconversationaddrequest.html @@ -0,0 +1,208 @@ + + + + + + GroupOptionalConversationAddRequest | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupOptionalConversationAddRequest

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupOptionalConversationAddRequest +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        chatName

        +
        chatName: string
        + +
        +
        + +

        chatSecurity

        +
        chatSecurity: ChatSecuritySetting
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupoptionalconversationeditrequest.html b/docs/interfaces/groupoptionalconversationeditrequest.html new file mode 100644 index 0000000..3ecea7e --- /dev/null +++ b/docs/interfaces/groupoptionalconversationeditrequest.html @@ -0,0 +1,222 @@ + + + + + + GroupOptionalConversationEditRequest | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupOptionalConversationEditRequest

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupOptionalConversationEditRequest +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        Optional chatEnabled

        +
        chatEnabled: boolean
        + +
        +
        + +

        chatName

        +
        chatName: string
        + +
        +
        + +

        Optional chatSecurity

        +
        chatSecurity: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupoptionseditaction.html b/docs/interfaces/groupoptionseditaction.html new file mode 100644 index 0000000..8f1fb6e --- /dev/null +++ b/docs/interfaces/groupoptionseditaction.html @@ -0,0 +1,290 @@ + + + + + + GroupOptionsEditAction | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupOptionsEditAction

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupOptionsEditAction +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        Optional HostGuidedGamePermissionOverride

        +
        HostGuidedGamePermissionOverride: number
        + +
        +
        +

        Minimum Member Level allowed to host guided games

        +
        +

        Always Allowed: Founder, Acting Founder, Admin

        +

        Allowed Overrides: None, Member, Beginner

        +

        Default is Member for clans, None for groups, although this means nothing for + groups.

        +
        +
        +
        + +

        Optional InvitePermissionOverride

        +
        InvitePermissionOverride: boolean
        + +
        +
        +

        Minimum Member Level allowed to invite new members to group

        +
        +

        Always Allowed: Founder, Acting Founder

        +

        True means admins have this power, false means they don't

        +

        Default is false for clans, true for groups.

        +
        +
        +
        + +

        Optional JoinLevel

        +
        JoinLevel: number
        + +
        +
        +

        Level to join a member at when accepting an invite, application, or joining an + open clan

        +
        +

        Default is Beginner.

        +
        +
        +
        + +

        Optional UpdateBannerPermissionOverride

        +
        UpdateBannerPermissionOverride: boolean
        + +
        +
        +

        Minimum Member Level allowed to update banner

        +
        +

        Always Allowed: Founder, Acting Founder

        +

        True means admins have this power, false means they don't

        +

        Default is false for clans, true for groups.

        +
        +
        +
        + +

        Optional UpdateCulturePermissionOverride

        +
        UpdateCulturePermissionOverride: boolean
        + +
        +
        +

        Minimum Member Level allowed to update group culture

        +
        +

        Always Allowed: Founder, Acting Founder

        +

        True means admins have this power, false means they don't

        +

        Default is false for clans, true for groups.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/grouppotentialmember.html b/docs/interfaces/grouppotentialmember.html new file mode 100644 index 0000000..77057e8 --- /dev/null +++ b/docs/interfaces/grouppotentialmember.html @@ -0,0 +1,250 @@ + + + + + + GroupPotentialMember | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupPotentialMember

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupPotentialMember +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        bungieNetUserInfo

        +
        bungieNetUserInfo: UserInfoCard
        + +
        +
        + +

        destinyUserInfo

        +
        destinyUserInfo: UserInfoCard
        + +
        +
        + +

        groupId

        +
        groupId: string
        + +
        +
        + +

        joinDate

        +
        joinDate: string
        + +
        +
        + +

        potentialStatus

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/grouppotentialmembership.html b/docs/interfaces/grouppotentialmembership.html new file mode 100644 index 0000000..f21f1f3 --- /dev/null +++ b/docs/interfaces/grouppotentialmembership.html @@ -0,0 +1,208 @@ + + + + + + GroupPotentialMembership | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupPotentialMembership

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupPotentialMembership +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        group

        +
        group: GroupV2
        + +
        +
        + +

        member

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/grouppotentialmembershipsearchresponse.html b/docs/interfaces/grouppotentialmembershipsearchresponse.html new file mode 100644 index 0000000..eacac7f --- /dev/null +++ b/docs/interfaces/grouppotentialmembershipsearchresponse.html @@ -0,0 +1,275 @@ + + + + + + GroupPotentialMembershipSearchResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupPotentialMembershipSearchResponse

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupPotentialMembershipSearchResponse +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        hasMore

        +
        hasMore: boolean
        + +
        +
        + +

        query

        +
        query: PagedQuery
        + +
        +
        + +

        replacementContinuationToken

        +
        replacementContinuationToken: string
        + +
        +
        + +

        results

        + + +
        +
        + +

        totalResults

        +
        totalResults: number
        + +
        +
        + +

        useTotalResults

        +
        useTotalResults: boolean
        + +
        +
        +

        If useTotalResults is true, then totalResults represents an accurate count.

        +
        +

        If False, it does not, and may be estimated/only the size of the current page.

        +

        Either way, you should probably always only trust hasMore.

        +

        This is a long-held historical throwback to when we used to do paging with known + total results. Those queries toasted our database, and we were left to hastily + alter our endpoints and create backward- compatible shims, of which + useTotalResults is one.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupquery.html b/docs/interfaces/groupquery.html new file mode 100644 index 0000000..6bf1ff2 --- /dev/null +++ b/docs/interfaces/groupquery.html @@ -0,0 +1,336 @@ + + + + + + GroupQuery | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupQuery

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        NOTE: GroupQuery, as of Destiny 2, has essentially two totally different and + incompatible "modes".

        +
        +

        If you are querying for a group, you can pass any of the properties below.

        +

        If you are querying for a Clan, you MUST NOT pass any of the following + properties (they must be null or undefined in your request, not just empty + string/default values):

        +
          +
        • groupMemberCountFilter - localeFilter - tagText
        • +
        +

        If you pass these, you will get a useless InvalidParameters error.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupQuery +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        creationDate

        +
        creationDate: GroupDateRange
        + +
        +
        + +

        currentPage

        +
        currentPage: number
        + +
        +
        + +

        Optional groupMemberCountFilter

        +
        groupMemberCountFilter: number
        + +
        +
        + +

        groupType

        +
        groupType: GroupType
        + +
        +
        + +

        itemsPerPage

        +
        itemsPerPage: number
        + +
        +
        + +

        localeFilter

        +
        localeFilter: string
        + +
        +
        + +

        name

        +
        name: string
        + +
        +
        + +

        requestContinuationToken

        +
        requestContinuationToken: string
        + +
        +
        + +

        sortBy

        +
        sortBy: GroupSortBy
        + +
        +
        + +

        tagText

        +
        tagText: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupresponse.html b/docs/interfaces/groupresponse.html new file mode 100644 index 0000000..a436f67 --- /dev/null +++ b/docs/interfaces/groupresponse.html @@ -0,0 +1,316 @@ + + + + + + GroupResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupResponse

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupResponse +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        allianceStatus

        +
        allianceStatus: GroupAllianceStatus
        + +
        +
        + +

        alliedIds

        +
        alliedIds: string[]
        + +
        +
        + +

        currentUserMemberMap

        +
        currentUserMemberMap: object
        + +
        +
        +

        This property will be populated if the authenticated user is a member of the + group. Note that because of account linking, a user can sometimes be part of a + clan more than once. As such, this returns the highest member type available.

        +
        +
        +
        +

        Type declaration

        +
          +
        +
        +
        +
        + +

        currentUserPotentialMemberMap

        +
        currentUserPotentialMemberMap: object
        + +
        +
        +

        This property will be populated if the authenticated user is an applicant or has + an outstanding invitation to join. Note that because of account linking, a user + can sometimes be part of a clan more than once.

        +
        +
        +
        +

        Type declaration

        +
          +
        +
        +
        +
        + +

        detail

        +
        detail: GroupV2
        + +
        +
        + +

        founder

        +
        founder: GroupMember
        + +
        +
        + +

        groupJoinInviteCount

        +
        groupJoinInviteCount: number
        + +
        +
        + +

        parentGroup

        +
        parentGroup: GroupV2
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupsearchresponse.html b/docs/interfaces/groupsearchresponse.html new file mode 100644 index 0000000..2e153c2 --- /dev/null +++ b/docs/interfaces/groupsearchresponse.html @@ -0,0 +1,275 @@ + + + + + + GroupSearchResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupSearchResponse

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupSearchResponse +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        hasMore

        +
        hasMore: boolean
        + +
        +
        + +

        query

        +
        query: PagedQuery
        + +
        +
        + +

        replacementContinuationToken

        +
        replacementContinuationToken: string
        + +
        +
        + +

        results

        +
        results: GroupV2Card[]
        + +
        +
        + +

        totalResults

        +
        totalResults: number
        + +
        +
        + +

        useTotalResults

        +
        useTotalResults: boolean
        + +
        +
        +

        If useTotalResults is true, then totalResults represents an accurate count.

        +
        +

        If False, it does not, and may be estimated/only the size of the current page.

        +

        Either way, you should probably always only trust hasMore.

        +

        This is a long-held historical throwback to when we used to do paging with known + total results. Those queries toasted our database, and we were left to hastily + alter our endpoints and create backward- compatible shims, of which + useTotalResults is one.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/grouptheme.html b/docs/interfaces/grouptheme.html new file mode 100644 index 0000000..a4b543a --- /dev/null +++ b/docs/interfaces/grouptheme.html @@ -0,0 +1,222 @@ + + + + + + GroupTheme | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupTheme

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupTheme +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        description

        +
        description: string
        + +
        +
        + +

        folder

        +
        folder: string
        + +
        +
        + +

        name

        +
        name: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupv2.html b/docs/interfaces/groupv2.html new file mode 100644 index 0000000..efbc2b9 --- /dev/null +++ b/docs/interfaces/groupv2.html @@ -0,0 +1,572 @@ + + + + + + GroupV2 | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupV2

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupV2 +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        about

        +
        about: string
        + +
        +
        + +

        allowChat

        +
        allowChat: boolean
        + +
        +
        + +

        avatarImageIndex

        +
        avatarImageIndex: number
        + +
        +
        + +

        avatarPath

        +
        avatarPath: string
        + +
        +
        + +

        Optional banExpireDate

        +
        banExpireDate: string
        + +
        +
        + +

        bannerPath

        +
        bannerPath: string
        + +
        +
        + +

        chatSecurity

        +
        chatSecurity: ChatSecuritySetting
        + +
        +
        + +

        clanInfo

        + + +
        +
        + +

        conversationId

        +
        conversationId: string
        + +
        +
        + +

        creationDate

        +
        creationDate: string
        + +
        +
        + +

        defaultPublicity

        +
        defaultPublicity: GroupPostPublicity
        + +
        +
        + +

        enableInvitationMessagingForAdmins

        +
        enableInvitationMessagingForAdmins: boolean
        + +
        +
        + +

        features

        +
        features: GroupFeatures
        + +
        +
        + +

        groupId

        +
        groupId: string
        + +
        +
        + +

        groupType

        +
        groupType: GroupType
        + +
        +
        + +

        homepage

        +
        homepage: GroupHomepage
        + +
        +
        + +

        isDefaultPostPublic

        +
        isDefaultPostPublic: boolean
        + +
        +
        + +

        isPublic

        +
        isPublic: boolean
        + +
        +
        + +

        isPublicTopicAdminOnly

        +
        isPublicTopicAdminOnly: boolean
        + +
        +
        + +

        locale

        +
        locale: string
        + +
        +
        + +

        memberCount

        +
        memberCount: number
        + +
        +
        + +

        membershipIdCreated

        +
        membershipIdCreated: string
        + +
        +
        + +

        membershipOption

        +
        membershipOption: MembershipOption
        + +
        +
        + +

        modificationDate

        +
        modificationDate: string
        + +
        +
        + +

        motto

        +
        motto: string
        + +
        +
        + +

        name

        +
        name: string
        + +
        +
        + +

        tags

        +
        tags: string[]
        + +
        +
        + +

        theme

        +
        theme: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupv2card.html b/docs/interfaces/groupv2card.html new file mode 100644 index 0000000..4beb915 --- /dev/null +++ b/docs/interfaces/groupv2card.html @@ -0,0 +1,376 @@ + + + + + + GroupV2Card | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupV2Card

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        A small infocard of group information, usually used for when a list of groups + are returned

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupV2Card +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        about

        +
        about: string
        + +
        +
        + +

        avatarPath

        +
        avatarPath: string
        + +
        +
        + +

        capabilities

        +
        capabilities: Capabilities
        + +
        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        +
        + +

        clanInfo

        +
        clanInfo: GroupV2ClanInfo
        + +
        +
        + +

        creationDate

        +
        creationDate: string
        + +
        +
        + +

        groupId

        +
        groupId: string
        + +
        +
        + +

        groupType

        +
        groupType: GroupType
        + +
        +
        + +

        locale

        +
        locale: string
        + +
        +
        + +

        memberCount

        +
        memberCount: number
        + +
        +
        + +

        membershipOption

        +
        membershipOption: MembershipOption
        + +
        +
        + +

        motto

        +
        motto: string
        + +
        +
        + +

        name

        +
        name: string
        + +
        +
        + +

        theme

        +
        theme: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupv2claninfo.html b/docs/interfaces/groupv2claninfo.html new file mode 100644 index 0000000..926245b --- /dev/null +++ b/docs/interfaces/groupv2claninfo.html @@ -0,0 +1,216 @@ + + + + + + GroupV2ClanInfo | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupV2ClanInfo

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This contract contains clan-specific group information. It does not include any + investment data.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupV2ClanInfo +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        clanBannerData

        +
        clanBannerData: ClanBanner
        + +
        +
        + +

        clanCallsign

        +
        clanCallsign: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/groupv2claninfoandinvestment.html b/docs/interfaces/groupv2claninfoandinvestment.html new file mode 100644 index 0000000..ab40484 --- /dev/null +++ b/docs/interfaces/groupv2claninfoandinvestment.html @@ -0,0 +1,237 @@ + + + + + + GroupV2ClanInfoAndInvestment | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface GroupV2ClanInfoAndInvestment

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The same as GroupV2ClanInfo, but includes any investment data.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + GroupV2ClanInfoAndInvestment +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        clanBannerData

        +
        clanBannerData: ClanBanner
        + +
        +
        + +

        clanCallsign

        +
        clanCallsign: string
        + +
        +
        + +

        d2ClanProgressions

        +
        d2ClanProgressions: object
        + +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/hyperlinkreference.html b/docs/interfaces/hyperlinkreference.html new file mode 100644 index 0000000..03a73d9 --- /dev/null +++ b/docs/interfaces/hyperlinkreference.html @@ -0,0 +1,208 @@ + + + + + + HyperlinkReference | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface HyperlinkReference

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + HyperlinkReference +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        title

        +
        title: string
        + +
        +
        + +

        url

        +
        url: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/iapiusage.html b/docs/interfaces/iapiusage.html deleted file mode 100644 index 6e97173..0000000 --- a/docs/interfaces/iapiusage.html +++ /dev/null @@ -1,238 +0,0 @@ - - - - - - IApiUsage | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IApiUsage

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IApiUsage -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        apiCalls

        -
        apiCalls: ISeries[]
        - -
        -
        -

        Counts for on API calls made for the time range.

        -
        -
        -
        -
        - -

        range

        -
        range: IDateRange
        - -
        -
        -

        The date range for the data being reported.

        -
        -
        -
        -
        - -

        throttledRequests

        -
        throttledRequests: ISeries[]
        - -
        -
        -

        Instances of blocked requests or requests that crossed the warn threshold during - the time range.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iapplication.html b/docs/interfaces/iapplication.html deleted file mode 100644 index ada4437..0000000 --- a/docs/interfaces/iapplication.html +++ /dev/null @@ -1,404 +0,0 @@ - - - - - - IApplication | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IApplication

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IApplication -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        applicationId

        -
        applicationId: number
        - -
        -
        -

        Unique ID assigned to the application

        -
        -
        -
        -
        - -

        applicationType

        -
        applicationType: OAuthApplicationType
        - -
        -
        - -

        creationDate

        -
        creationDate: string
        - -
        -
        -

        Date the application was first added to our database.

        -
        -
        -
        -
        - -

        firstPublished

        -
        firstPublished: string
        - -
        -
        -

        Date the first time the application status entered the 'Public' status.

        -
        -
        -
        -
        - -

        link

        -
        link: string
        - -
        -
        -

        Link to website for the application where a user can learn more about the app.

        -
        -
        -
        -
        - -

        name

        -
        name: string
        - -
        -
        -

        Name of the application

        -
        -
        -
        -
        - -

        origin

        -
        origin: string
        - -
        -
        -

        Value of the Origin header sent in requests generated by this application.

        -
        -
        -
        -
        - -

        redirectUrl

        -
        redirectUrl: string
        - -
        -
        -

        URL used to pass the user's authorization code to the application

        -
        -
        -
        -
        - -

        scope

        -
        scope: string
        - -
        -
        -

        Permissions the application needs to work

        -
        -
        -
        -
        - -

        status

        - - -
        -
        -

        Current status of the application.

        -
        -
        -
        -
        - -

        statusChanged

        -
        statusChanged: string
        - -
        -
        -

        Date the application status last changed.

        -
        -
        -
        -
        - -

        team

        - - -
        -
        -

        List of team members who manage this application on Bungie.net. Will always - consist of at least the application owner.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iapplicationdeveloper.html b/docs/interfaces/iapplicationdeveloper.html deleted file mode 100644 index 0b222b1..0000000 --- a/docs/interfaces/iapplicationdeveloper.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IApplicationDeveloper | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IApplicationDeveloper

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IApplicationDeveloper -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        apiEulaVersion

        -
        apiEulaVersion: number
        - -
        -
        - -

        role

        - - -
        -
        - -

        user

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iawaauthorizationresult.html b/docs/interfaces/iawaauthorizationresult.html deleted file mode 100644 index e9025aa..0000000 --- a/docs/interfaces/iawaauthorizationresult.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - IAwaAuthorizationResult | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IAwaAuthorizationResult

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IAwaAuthorizationResult -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        actionToken

        -
        actionToken: string
        - -
        -
        -

        Credential used to prove the user authorized an advanced write action.

        -
        -
        -
        -
        - -

        developerNote

        -
        developerNote: string
        - -
        -
        -

        Message to the app developer to help understand the response.

        -
        -
        -
        -
        - -

        maximumNumberOfUses

        -
        maximumNumberOfUses: number
        - -
        -
        -

        This token may be used to perform the requested action this number of times, at - a maximum. If this value is 0, then there is no limit.

        -
        -
        -
        -
        - -

        membershipType

        -
        membershipType: BungieMembershipType
        - -
        -
        -

        MembershipType from the permission request.

        -
        -
        -
        -
        - -

        responseReason

        -
        responseReason: AwaResponseReason
        - -
        -
        - -

        type

        -
        type: AwaType
        - -
        -
        -

        Advanced Write Action Type from the permission request.

        -
        -
        -
        -
        - -

        userSelection

        -
        userSelection: AwaUserSelection
        - -
        -
        -

        Indication of how the user responded to the request. If the value is "Approved" - the actionToken will contain the token that can be presented when performing the - advanced write action.

        -
        -
        -
        -
        - -

        Optional validUntil

        -
        validUntil: string
        - -
        -
        -

        Time, UTC, when token expires.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iawainitializeresponse.html b/docs/interfaces/iawainitializeresponse.html deleted file mode 100644 index 41b15c5..0000000 --- a/docs/interfaces/iawainitializeresponse.html +++ /dev/null @@ -1,219 +0,0 @@ - - - - - - IAwaInitializeResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IAwaInitializeResponse

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IAwaInitializeResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        correlationId

        -
        correlationId: string
        - -
        -
        -

        ID used to get the token. Present this ID to the user as it will identify this - specific request on their device.

        -
        -
        -
        -
        - -

        sentToSelf

        -
        sentToSelf: boolean
        - -
        -
        -

        True if the PUSH message will only be sent to the device that made this request.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iawapermissionrequested.html b/docs/interfaces/iawapermissionrequested.html deleted file mode 100644 index c199d87..0000000 --- a/docs/interfaces/iawapermissionrequested.html +++ /dev/null @@ -1,258 +0,0 @@ - - - - - - IAwaPermissionRequested | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IAwaPermissionRequested

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IAwaPermissionRequested -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        Optional affectedItemId

        -
        affectedItemId: string
        - -
        -
        -

        Item instance ID the action shall be applied to. This is optional for all but a - new AwaType values. Rule of thumb is to provide the item instance ID if one is - available.

        -
        -
        -
        -
        - -

        Optional characterId

        -
        characterId: string
        - -
        -
        -

        Destiny character ID, if applicable, that will be affected by the action.

        -
        -
        -
        -
        - -

        membershipType

        -
        membershipType: BungieMembershipType
        - -
        -
        -

        Destiny membership type of the account to modify.

        -
        -
        -
        -
        - -

        type

        -
        type: AwaType
        - -
        -
        -

        Type of advanced write action.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iawauserresponse.html b/docs/interfaces/iawauserresponse.html deleted file mode 100644 index a96b004..0000000 --- a/docs/interfaces/iawauserresponse.html +++ /dev/null @@ -1,237 +0,0 @@ - - - - - - IAwaUserResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IAwaUserResponse

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IAwaUserResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        correlationId

        -
        correlationId: string
        - -
        -
        -

        Correlation ID of the request

        -
        -
        -
        -
        - -

        nonce

        -
        nonce: number[]
        - -
        -
        -

        Secret nonce received via the PUSH notification.

        -
        -
        -
        -
        - -

        selection

        -
        selection: AwaUserSelection
        - -
        -
        -

        Indication of the selection the user has made (Approving or rejecting the action)

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iclanbanner.html b/docs/interfaces/iclanbanner.html deleted file mode 100644 index 8600ce1..0000000 --- a/docs/interfaces/iclanbanner.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - IClanBanner | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IClanBanner

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IClanBanner -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        decalBackgroundColorId

        -
        decalBackgroundColorId: number
        - -
        -
        - -

        decalColorId

        -
        decalColorId: number
        - -
        -
        - -

        decalId

        -
        decalId: number
        - -
        -
        - -

        gonfalonColorId

        -
        gonfalonColorId: number
        - -
        -
        - -

        gonfalonDetailColorId

        -
        gonfalonDetailColorId: number
        - -
        -
        - -

        gonfalonDetailId

        -
        gonfalonDetailId: number
        - -
        -
        - -

        gonfalonId

        -
        gonfalonId: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/icommentsummary.html b/docs/interfaces/icommentsummary.html deleted file mode 100644 index 2052c8f..0000000 --- a/docs/interfaces/icommentsummary.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - ICommentSummary | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ICommentSummary

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ICommentSummary -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        commentCount

        -
        commentCount: number
        - -
        -
        - -

        topicId

        -
        topicId: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/icommunitylivestatus.html b/docs/interfaces/icommunitylivestatus.html deleted file mode 100644 index 05ab133..0000000 --- a/docs/interfaces/icommunitylivestatus.html +++ /dev/null @@ -1,488 +0,0 @@ - - - - - - ICommunityLiveStatus | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ICommunityLiveStatus

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ICommunityLiveStatus -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activityModeHash

        -
        activityModeHash: number
        - -
        -
        - -

        currentActivityHash

        -
        currentActivityHash: number
        - -
        -
        - -

        currentViewers

        -
        currentViewers: number
        - -
        -
        - -

        Optional dateFeatured

        -
        dateFeatured: string
        - -
        -
        - -

        dateLastPlayed

        -
        dateLastPlayed: string
        - -
        -
        - -

        dateStatusUpdated

        -
        dateStatusUpdated: string
        - -
        -
        - -

        dateStreamStarted

        -
        dateStreamStarted: string
        - -
        -
        - -

        destinyCharacterId

        -
        destinyCharacterId: string
        - -
        -
        - -

        followers

        -
        followers: number
        - -
        -
        - -

        isFeatured

        -
        isFeatured: boolean
        - -
        -
        - -

        isSubscribable

        -
        isSubscribable: boolean
        - -
        -
        - -

        locale

        -
        locale: string
        - -
        -
        - -

        overallViewers

        -
        overallViewers: number
        - -
        -
        - -

        partnershipIdentifier

        -
        partnershipIdentifier: string
        - -
        -
        - -

        partnershipType

        -
        partnershipType: PartnershipType
        - -
        -
        - -

        thumbnail

        -
        thumbnail: string
        - -
        -
        - -

        thumbnailLarge

        -
        thumbnailLarge: string
        - -
        -
        - -

        thumbnailSmall

        -
        thumbnailSmall: string
        - -
        -
        - -

        title

        -
        title: string
        - -
        -
        - -

        trendingValue

        -
        trendingValue: number
        - -
        -
        - -

        url

        -
        url: string
        - -
        -
        - -

        userInfo

        -
        userInfo: IUserInfoCard
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/icontentitempubliccontract.html b/docs/interfaces/icontentitempubliccontract.html deleted file mode 100644 index 6de4115..0000000 --- a/docs/interfaces/icontentitempubliccontract.html +++ /dev/null @@ -1,410 +0,0 @@ - - - - - - IContentItemPublicContract | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IContentItemPublicContract

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IContentItemPublicContract -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        allowComments

        -
        allowComments: boolean
        - -
        -
        - -

        author

        -
        author: IGeneralUser
        - -
        -
        - -

        autoEnglishPropertyFallback

        -
        autoEnglishPropertyFallback: boolean
        - -
        -
        - -

        cType

        -
        cType: string
        - -
        -
        - -

        cmsPath

        -
        cmsPath: string
        - -
        -
        - -

        commentSummary

        -
        commentSummary: ICommentSummary
        - -
        -
        - -

        contentId

        -
        contentId: string
        - -
        -
        - -

        creationDate

        -
        creationDate: string
        - -
        -
        - -

        hasAgeGate

        -
        hasAgeGate: boolean
        - -
        -
        - -

        minimumAge

        -
        minimumAge: number
        - -
        -
        - -

        modifyDate

        -
        modifyDate: string
        - -
        -
        - -

        properties

        -
        properties: object
        - -
        -
        -

        Firehose content is really a collection of metadata and "properties", which are - the potentially-but-not-strictly localizable data that comprises the meat of - whatever content is being shown.

        -
        -

        As Cole Porter would have crooned, "Anything Goes" with Firehose properties. - They are most often strings, but they can theoretically be anything. They are - JSON encoded, and could be JSON structures, simple strings, numbers etc... The - Content Type of the item (cType) will describe the properties, and thus how they - ought to be deserialized.

        -
        -
        -

        Type declaration

        -
          -
        • -
          [key: string]: object
          -
        • -
        -
        -
        -
        - -

        ratingImagePath

        -
        ratingImagePath: string
        - -
        -
        - -

        representations

        -
        representations: IContentRepresentation[]
        - -
        -
        - -

        tags

        -
        tags: string[]
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/icontentpreview.html b/docs/interfaces/icontentpreview.html deleted file mode 100644 index 114c41d..0000000 --- a/docs/interfaces/icontentpreview.html +++ /dev/null @@ -1,264 +0,0 @@ - - - - - - IContentPreview | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IContentPreview

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IContentPreview -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        itemInSet

        -
        itemInSet: boolean
        - -
        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        path

        -
        path: string
        - -
        -
        - -

        setNesting

        -
        setNesting: number
        - -
        -
        - -

        setTag

        -
        setTag: string
        - -
        -
        - -

        useSetId

        -
        useSetId: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/icontentrepresentation.html b/docs/interfaces/icontentrepresentation.html deleted file mode 100644 index 25bbd3f..0000000 --- a/docs/interfaces/icontentrepresentation.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IContentRepresentation | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IContentRepresentation

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IContentRepresentation -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        path

        -
        path: string
        - -
        -
        - -

        validationString

        -
        validationString: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/icontenttypedefaultvalue.html b/docs/interfaces/icontenttypedefaultvalue.html deleted file mode 100644 index 92d5290..0000000 --- a/docs/interfaces/icontenttypedefaultvalue.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IContentTypeDefaultValue | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IContentTypeDefaultValue

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IContentTypeDefaultValue -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        defaultValue

        -
        defaultValue: string
        - -
        -
        - -

        whenClause

        -
        whenClause: string
        - -
        -
        - -

        whenValue

        -
        whenValue: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/icontenttypedescription.html b/docs/interfaces/icontenttypedescription.html deleted file mode 100644 index b733c8e..0000000 --- a/docs/interfaces/icontenttypedescription.html +++ /dev/null @@ -1,482 +0,0 @@ - - - - - - IContentTypeDescription | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IContentTypeDescription

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IContentTypeDescription -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        allowComments

        -
        allowComments: boolean
        - -
        -
        - -

        autoEnglishPropertyFallback

        -
        autoEnglishPropertyFallback: boolean
        - -
        -
        - -

        bindIdentifierToProperty

        -
        bindIdentifierToProperty: string
        - -
        -
        - -

        boundRegex

        -
        boundRegex: string
        - -
        -
        - -

        bulkUploadable

        -
        bulkUploadable: boolean
        - -
        -
        - -

        cType

        -
        cType: string
        - -
        -
        - -

        contentDescription

        -
        contentDescription: string
        - -
        -
        - -

        forceIdentifierBinding

        -
        forceIdentifierBinding: boolean
        - -
        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        previewImage

        -
        previewImage: string
        - -
        -
        - -

        previews

        -
        previews: IContentPreview[]
        - -
        -
        - -

        priority

        -
        priority: number
        - -
        -
        - -

        properties

        -
        properties: IContentTypeProperty[]
        - -
        -
        - -

        propertySections

        -
        propertySections: IContentTypePropertySection[]
        - -
        -
        - -

        reminder

        -
        reminder: string
        - -
        -
        - -

        showInContentEditor

        -
        showInContentEditor: boolean
        - -
        -
        - -

        suppressCmsPath

        -
        suppressCmsPath: boolean
        - -
        -
        - -

        tagMetadata

        -
        tagMetadata: ITagMetadataDefinition[]
        - -
        -
        - -

        tagMetadataItems

        -
        tagMetadataItems: object
        - -
        -

        Type declaration

        - -
        -
        -
        - -

        typeOf

        -
        typeOf: string
        - -
        -
        - -

        usageExamples

        -
        usageExamples: string[]
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/icontenttypeproperty.html b/docs/interfaces/icontenttypeproperty.html deleted file mode 100644 index 7d1a254..0000000 --- a/docs/interfaces/icontenttypeproperty.html +++ /dev/null @@ -1,770 +0,0 @@ - - - - - - IContentTypeProperty | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IContentTypeProperty

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IContentTypeProperty -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        attributes

        -
        attributes: object
        - -
        -

        Type declaration

        -
          -
        • -
          [key: string]: string
          -
        • -
        -
        -
        -
        - -

        bindToProperty

        -
        bindToProperty: string
        - -
        -
        - -

        boundRegex

        -
        boundRegex: string
        - -
        -
        - -

        childProperties

        -
        childProperties: IContentTypeProperty[]
        - -
        -
        - -

        contentTypeAllowed

        -
        contentTypeAllowed: string
        - -
        -
        - -

        datatype

        - - -
        -
        - -

        defaultValues

        -
        defaultValues: IContentTypeDefaultValue[]
        - -
        -
        - -

        enabled

        -
        enabled: boolean
        - -
        -
        - -

        entitytype

        -
        entitytype: string
        - -
        -
        - -

        fallback

        -
        fallback: boolean
        - -
        -
        - -

        isCombo

        -
        isCombo: boolean
        - -
        -
        - -

        isExternalAllowed

        -
        isExternalAllowed: boolean
        - -
        -
        - -

        isImage

        -
        isImage: boolean
        - -
        -
        - -

        isTitle

        -
        isTitle: boolean
        - -
        -
        - -

        isVideo

        -
        isVideo: boolean
        - -
        -
        - -

        legalContentTypes

        -
        legalContentTypes: string[]
        - -
        -
        - -

        localizable

        -
        localizable: boolean
        - -
        -
        - -

        maxByteLength

        -
        maxByteLength: number
        - -
        -
        - -

        maxFileSize

        -
        maxFileSize: number
        - -
        -
        - -

        maxHeight

        -
        maxHeight: number
        - -
        -
        - -

        maxLength

        -
        maxLength: number
        - -
        -
        - -

        maxWidth

        -
        maxWidth: number
        - -
        -
        - -

        minHeight

        -
        minHeight: number
        - -
        -
        - -

        minWidth

        -
        minWidth: number
        - -
        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        order

        -
        order: number
        - -
        -
        - -

        propertyDescription

        -
        propertyDescription: string
        - -
        -
        - -

        propertySection

        -
        propertySection: string
        - -
        -
        - -

        readableName

        -
        readableName: string
        - -
        -
        - -

        regexp

        -
        regexp: string
        - -
        -
        - -

        representationSelection

        -
        representationSelection: object
        - -
        -

        Type declaration

        -
          -
        • -
          [key: string]: string
          -
        • -
        -
        -
        -
        - -

        representationValidationString

        -
        representationValidationString: string
        - -
        -
        - -

        required

        -
        required: boolean
        - -
        -
        - -

        rssAttribute

        -
        rssAttribute: string
        - -
        -
        - -

        suppressProperty

        -
        suppressProperty: boolean
        - -
        -
        - -

        validateAs

        -
        validateAs: string
        - -
        -
        - -

        value

        -
        value: string
        - -
        -
        - -

        visible

        -
        visible: boolean
        - -
        -
        - -

        visibleDependency

        -
        visibleDependency: string
        - -
        -
        - -

        visibleOn

        -
        visibleOn: string
        - -
        -
        - -

        weight

        -
        weight: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/icontenttypepropertysection.html b/docs/interfaces/icontenttypepropertysection.html deleted file mode 100644 index 536aae5..0000000 --- a/docs/interfaces/icontenttypepropertysection.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IContentTypePropertySection | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IContentTypePropertySection

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IContentTypePropertySection -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        collapsed

        -
        collapsed: boolean
        - -
        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        readableName

        -
        readableName: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idatapoint.html b/docs/interfaces/idatapoint.html deleted file mode 100644 index 97468f5..0000000 --- a/docs/interfaces/idatapoint.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - - IDatapoint | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDatapoint

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDatapoint -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        Optional count

        -
        count: number
        - -
        -
        -

        Count associated with timestamp

        -
        -
        -
        -
        - -

        time

        -
        time: string
        - -
        -
        -

        Timestamp for the related count.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idaterange.html b/docs/interfaces/idaterange.html deleted file mode 100644 index 0e87304..0000000 --- a/docs/interfaces/idaterange.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IDateRange | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDateRange

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDateRange -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        end

        -
        end: string
        - -
        -
        - -

        start

        -
        start: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivity.html b/docs/interfaces/idestinyactivity.html deleted file mode 100644 index 84d2263..0000000 --- a/docs/interfaces/idestinyactivity.html +++ /dev/null @@ -1,368 +0,0 @@ - - - - - - IDestinyActivity | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivity

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents the "Live" data that we can obtain about a Character's status with a - specific Activity. This will tell you whether the character can participate in - the activity, as well as some other basic mutable information.

        -
        -

        Meant to be combined with static DestinyActivityDefinition data for a full - picture of the Activity.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivity -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activityHash

        -
        activityHash: number
        - -
        -
        -

        The hash identifier of the Activity. Use this to look up the - DestinyActivityDefinition of the activity.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        canJoin

        -
        canJoin: boolean
        - -
        -
        -

        If true, the user is allowed to join with another Fireteam in this activity.

        -
        -
        -
        -
        - -

        canLead

        -
        canLead: boolean
        - -
        -
        -

        If true, the user is allowed to lead a Fireteam into this activity.

        -
        -
        -
        -
        - -

        difficultyTier

        - - -
        -
        -

        A DestinyActivityDifficultyTier enum value indicating the difficulty of the - activity.

        -
        -
        -
        -
        - -

        Optional displayLevel

        -
        displayLevel: number
        - -
        -
        -

        The difficulty level of the activity, if applicable.

        -
        -
        -
        -
        - -

        isCompleted

        -
        isCompleted: boolean
        - -
        -
        -

        If true, we both have the ability to know that the user has completed this - activity and they have completed it. Unfortunately, we can't necessarily know - this for all activities. As such, this should probably only be used if you - already know in advance which specific activities you wish to check.

        -
        -
        -
        -
        - -

        isNew

        -
        isNew: boolean
        - -
        -
        -

        If true, then the activity should have a "new" indicator in the Director UI.

        -
        -
        -
        -
        - -

        isVisible

        -
        isVisible: boolean
        - -
        -
        -

        If true, the user should be able to see this activity.

        -
        -
        -
        -
        - -

        Optional recommendedLight

        -
        recommendedLight: number
        - -
        -
        -

        The recommended light level for the activity, if applicable.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitychallengedefinition.html b/docs/interfaces/idestinyactivitychallengedefinition.html deleted file mode 100644 index 60c38c9..0000000 --- a/docs/interfaces/idestinyactivitychallengedefinition.html +++ /dev/null @@ -1,230 +0,0 @@ - - - - - - IDestinyActivityChallengeDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityChallengeDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents a reference to a Challenge, which for now is just an Objective.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityChallengeDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        dummyRewards

        -
        dummyRewards: IDestinyItemQuantity[]
        - -
        -
        -

        The rewards as they're represented in the UI. Note that they generally link to " - dummy" items that give a summary of rewards rather than direct, real items - themselves.

        -
        -

        If the quantity is 0, don't show the quantity.

        -
        -
        -
        - -

        objectiveHash

        -
        objectiveHash: number
        - -
        -
        -

        The hash for the Objective that matches this challenge. Use it to look up the - DestinyObjectiveDefinition.

        -
        -

        Mapped to IDestinyObjectiveDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitydefinition.html b/docs/interfaces/idestinyactivitydefinition.html deleted file mode 100644 index 74d3abe..0000000 --- a/docs/interfaces/idestinyactivitydefinition.html +++ /dev/null @@ -1,884 +0,0 @@ - - - - - - IDestinyActivityDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The static data about Activities in Destiny 2.

        -
        -

        Note that an Activity must be combined with an ActivityMode to know - from a - Gameplay perspective - what the user is "Playing".

        -

        In most PvE activities, this is fairly straightforward. A Story Activity can - only be played in the Story Activity Mode.

        -

        However, in PvP activities, the Activity alone only tells you the map being - played, or the Playlist that the user chose to enter. You'll need to know the - Activity Mode they're playing to know that they're playing Mode X on Map Y.

        -

        Activity Definitions tell a great deal of information about what could be - relevant to a user: what rewards they can earn, what challenges could be - performed, what modifiers could be applied. To figure out which of these - properties is actually live, you'll need to combine the definition with "Live" - data from one of the Destiny endpoints.

        -

        Activities also have Activity Types, but unfortunately in Destiny 2 these are - even less reliable of a source of information than they were in Destiny 1. I - will be looking into ways to provide more reliable sources for type information - as time goes on, but for now we're going to have to deal with the limitations. - See DestinyActivityTypeDefinition for more information.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activityGraphList

        - - -
        -
        -

        Unfortunately, in practice this is almost never populated. In theory, this is - supposed to tell which Activity Graph to show if you bring up the director while - in this activity.

        -
        -
        -
        -
        - -

        activityLevel

        -
        activityLevel: number
        - -
        -
        -

        The difficulty level of the activity.

        -
        -
        -
        -
        - -

        activityLightLevel

        -
        activityLightLevel: number
        - -
        -
        -

        The recommended light level for this activity.

        -
        -
        -
        -
        - -

        activityLocationMappings

        -
        activityLocationMappings: IDestinyEnvironmentLocationMapping[]
        - -
        -
        -

        A list of location mappings that are affected by this activity. Pulled out of - DestinyLocationDefinitions for our/your lookup convenience.

        -
        -
        -
        -
        - -

        activityModeHashes

        -
        activityModeHashes: number[]
        - -
        -
        -

        The hash identifiers for Activity Modes relevant to this activity. Note that if - this is a playlist, the specific playlist entry chosen will determine the actual - activity modes that end up being relevant.

        -
        -

        Mapped to IDestinyActivityModeDefinition in the manifest.

        -
        -
        -
        - -

        activityModeTypes

        -
        activityModeTypes: DestinyActivityModeType[]
        - -
        -
        -

        The activity modes - if any - in enum form. Because we can't seem to escape the - enums.

        -
        -
        -
        -
        - -

        activityTypeHash

        -
        activityTypeHash: number
        - -
        -
        -

        The hash identifier for the Activity Type of this Activity. You may use it to - look up the DestinyActivityTypeDefinition for human readable info, but be - forewarned: Playlists and many PVP Map Activities will map to generic Activity - Types. You'll have to use your knowledge of the Activity Mode being played to - get more specific information about what the user is playing.

        -
        -

        Mapped to IDestinyActivityTypeDefinition in the manifest.

        -
        -
        -
        - -

        challenges

        - - -
        -
        -

        An activity can have many Challenges, of which any subset of them may be active - for play at any given period of time. This gives the information about the - challenges and data that we use to understand when they're active and what - rewards they provide. Sadly, at the moment there's no central definition for - challenges: much like "Skulls" were in Destiny 1, these are defined on - individual activities and there can be many duplicates/near duplicates across - the Destiny 2 ecosystem. I have it in mind to centralize these in a future - revision of the API, but we are out of time.

        -
        -
        -
        -
        - -

        destinationHash

        -
        destinationHash: number
        - -
        -
        -

        The hash identifier for the Destination on which this Activity is played. Use it - to look up the DestinyDestinationDefinition for human readable info about the - destination. A Destination can be thought of as a more specific location than a " - Place". For instance, if the "Place" is Earth, the "Destination" would be a - specific city or region on Earth.

        -
        -

        Mapped to IDestinyDestinationDefinition in the manifest.

        -
        -
        -
        - -

        Optional directActivityModeHash

        -
        directActivityModeHash: number
        - -
        -
        -

        If this activity had an activity mode directly defined on it, this will be the - hash of that mode.

        -
        -

        Mapped to IDestinyActivityModeDefinition in the manifest.

        -
        -
        -
        - -

        Optional directActivityModeType

        -
        directActivityModeType: number
        - -
        -
        -

        If the activity had an activity mode directly defined on it, this will be the - enum value of that mode.

        -
        -
        -
        -
        - -

        displayProperties

        - - -
        -
        -

        The title, subtitle, and icon for the activity. We do a little post-processing - on this to try and account for Activities where the designers have left this - data too minimal to determine what activity is actually being played.

        -
        -
        -
        -
        - -

        guidedGame

        - - -
        -
        -

        This block of data, if it exists, provides information about the guided game - experience and restrictions for this activity. If it doesn't exist, the game is - not able to be played as a guided game.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        insertionPoints

        - - -
        -
        -

        The list of phases or points of entry into an activity, along with information - we can use to determine their gating and availability.

        -
        -
        -
        -
        - -

        isPlaylist

        -
        isPlaylist: boolean
        - -
        -
        -

        If True, this Activity is actually a Playlist that refers to multiple possible - specific Activities and Activity Modes. For instance, a Crucible Playlist may - have references to multiple Activities (Maps) with multiple Activity Modes ( - specific PvP gameplay modes). If this is true, refer to the playlistItems - property for the specific entries in the playlist.

        -
        -
        -
        -
        - -

        isPvP

        -
        isPvP: boolean
        - -
        -
        -

        If true, this activity is a PVP activity or playlist.

        -
        -
        -
        -
        - -

        loadouts

        - - -
        -
        -

        The set of all possible loadout requirements that could be active for this - activity. Only one will be active at any given time, and you can discover which - one through activity-associated data such as Milestones that have activity info - on them.

        -
        -
        -
        -
        - -

        matchmaking

        - - -
        -
        -

        This block of data provides information about the Activity's matchmaking - attributes: how many people can join and such.

        -
        -
        -
        -
        - -

        modifiers

        - - -
        -
        -

        Activities can have Modifiers, as defined in DestinyActivityModifierDefinition. - These are references to the modifiers that can be applied to that activity, - along with data that we use to determine if that modifier is actually active at - any given point in time.

        -
        -
        -
        -
        - -

        optionalUnlockStrings

        - - -
        -
        -

        If there are status strings related to the activity and based on internal state - of the game, account, or character, then this will be the definition of those - strings and the states needed in order for the strings to be shown.

        -
        -
        -
        -
        - -

        originalDisplayProperties

        -
        originalDisplayProperties: IDestinyDisplayPropertiesDefinition
        - -
        -
        -

        The unadulterated form of the display properties, as they ought to be shown in - the Director (if the activity appears in the director).

        -
        -
        -
        -
        - -

        pgcrImage

        -
        pgcrImage: string
        - -
        -
        -

        When Activities are completed, we generate a "Post-Game Carnage Report", or PGCR, - with details about what happened in that activity (how many kills someone got, - which team won, etc...) We use this image as the background when displaying PGCR - information, and often use it when we refer to the Activity in general.

        -
        -
        -
        -
        - -

        placeHash

        -
        placeHash: number
        - -
        -
        -

        The hash identifier for the "Place" on which this Activity is played. Use it to - look up the DestinyPlaceDefinition for human readable info about the Place. A - Place is the largest-scoped concept for location information. For instance, if - the "Place" is Earth, the "Destination" would be a specific city or region on - Earth.

        -
        -

        Mapped to IDestinyPlaceDefinition in the manifest.

        -
        -
        -
        - -

        playlistItems

        - - -
        -
        -

        Represents all of the possible activities that could be played in the Playlist, - along with information that we can use to determine if they are active at the - present time.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        releaseIcon

        -
        releaseIcon: string
        - -
        -
        -

        If the activity has an icon associated with a specific release (such as a DLC), - this is the path to that release's icon.

        -
        -
        -
        -
        - -

        releaseTime

        -
        releaseTime: number
        - -
        -
        -

        If the activity will not be visible until a specific and known time, this will - be the seconds since the Epoch when it will become visible.

        -
        -
        -
        -
        - -

        rewards

        - - -
        -
        -

        The expected possible rewards for the activity. These rewards may or may not be - accessible for an individual player based on their character state, the account - state, and even the game's state overall. But it is a useful reference for - possible rewards you can earn in the activity. These match up to rewards - displayed when you hover over the Activity in the in-game Director, and often - refer to Placeholder or "Dummy" items: items that tell you what you can earn in - vague terms rather than what you'll specifically be earning (partly because the - game doesn't even know what you'll earn specifically until you roll for it at - the end)

        -
        -
        -
        -
        - -

        selectionScreenDisplayProperties

        -
        selectionScreenDisplayProperties: IDestinyDisplayPropertiesDefinition
        - -
        -
        -

        The title, subtitle, and icon for the activity as determined by Selection Screen - data, if there is any for this activity. There won't be data in this field if - the activity is never shown in a selection/options screen.

        -
        -
        -
        -
        - -

        tier

        -
        tier: number
        - -
        -
        -

        The difficulty tier of the activity.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitygraphartelementdefinition.html b/docs/interfaces/idestinyactivitygraphartelementdefinition.html deleted file mode 100644 index 8eb8964..0000000 --- a/docs/interfaces/idestinyactivitygraphartelementdefinition.html +++ /dev/null @@ -1,209 +0,0 @@ - - - - - - IDestinyActivityGraphArtElementDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityGraphArtElementDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        These Art Elements are meant to represent one-off visual effects overlaid on the - map. Currently, we do not have a pipeline to import the assets for these - overlays, so this info exists as a placeholder for when such a pipeline exists ( - if it ever will)

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityGraphArtElementDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        position

        - - -
        -
        -

        The position on the map of the art element.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitygraphconnectiondefinition.html b/docs/interfaces/idestinyactivitygraphconnectiondefinition.html deleted file mode 100644 index de8f0b6..0000000 --- a/docs/interfaces/idestinyactivitygraphconnectiondefinition.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - - IDestinyActivityGraphConnectionDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityGraphConnectionDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Nodes on a graph can be visually connected: this appears to be the information - about which nodes to link. It appears to lack more detailed information, such as - the path for that linking.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityGraphConnectionDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        destNodeHash

        -
        destNodeHash: number
        - -
        -
        - -

        sourceNodeHash

        -
        sourceNodeHash: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitygraphdefinition.html b/docs/interfaces/idestinyactivitygraphdefinition.html deleted file mode 100644 index 60f45c5..0000000 --- a/docs/interfaces/idestinyactivitygraphdefinition.html +++ /dev/null @@ -1,381 +0,0 @@ - - - - - - IDestinyActivityGraphDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityGraphDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents a Map View in the director: be them overview views, destination views, - or other.

        -
        -

        They have nodes which map to activities, and other various visual elements that - we (or others) may or may not be able to use.

        -

        Activity graphs, most importantly, have nodes which can have activities in - various states of playability.

        -

        Unfortunately, activity graphs are combined at runtime with Game UI-only assets - such as fragments of map images, various in-game special effects, decals etc... - that we don't get in these definitions.

        -

        If we end up having time, we may end up trying to manually populate those here: - but the last time we tried that, before the lead-up to D1, it proved to be - unmaintainable as the game's content changed. So don't bet the farm on us - providing that content in this definition.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityGraphDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        artElements

        - - -
        -
        -

        Represents one-off/special UI elements that appear on the map.

        -
        -
        -
        -
        - -

        connections

        - - -
        -
        -

        Represents connections between graph nodes. However, it lacks context that we'd - need to make good use of it.

        -
        -
        -
        -
        - -

        displayObjectives

        - - -
        -
        -

        Objectives can display on maps, and this is supposedly metadata for that. I have - not had the time to analyze the details of what is useful within however: we - could be missing important data to make this work. Expect this property to be - expanded on later if possible.

        -
        -
        -
        -
        - -

        displayProgressions

        - - -
        -
        -

        Progressions can also display on maps, but similarly to displayObjectives we - appear to lack some required information and context right now. We will have to - look into it later and add more data if possible.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        linkedGraphs

        - - -
        -
        -

        Represents links between this Activity Graph and other ones.

        -
        -
        -
        -
        - -

        nodes

        - - -
        -
        -

        These represent the visual "nodes" on the map's view. These are the activities - you can click on in the map.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitygraphdisplayobjectivedefinition.html b/docs/interfaces/idestinyactivitygraphdisplayobjectivedefinition.html deleted file mode 100644 index 2e8b3b5..0000000 --- a/docs/interfaces/idestinyactivitygraphdisplayobjectivedefinition.html +++ /dev/null @@ -1,228 +0,0 @@ - - - - - - IDestinyActivityGraphDisplayObjectiveDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityGraphDisplayObjectiveDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        When a Graph needs to show active Objectives, this defines those objectives as - well as an identifier.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityGraphDisplayObjectiveDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        id

        -
        id: number
        - -
        -
        -

        $NOTE $amola 2017-01-19 This field is apparently something that CUI uses to - manually wire up objectives to display info. I am unsure how it works.

        -
        -
        -
        -
        - -

        objectiveHash

        -
        objectiveHash: number
        - -
        -
        -

        The objective being shown on the map.

        -
        -

        Mapped to IDestinyObjectiveDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitygraphdisplayprogressiondefinition.html b/docs/interfaces/idestinyactivitygraphdisplayprogressiondefinition.html deleted file mode 100644 index 0ee0de9..0000000 --- a/docs/interfaces/idestinyactivitygraphdisplayprogressiondefinition.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - - IDestinyActivityGraphDisplayProgressionDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityGraphDisplayProgressionDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        When a Graph needs to show active Progressions, this defines those objectives as - well as an identifier.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityGraphDisplayProgressionDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        id

        -
        id: number
        - -
        -
        - -

        progressionHash

        -
        progressionHash: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitygraphlistentrydefinition.html b/docs/interfaces/idestinyactivitygraphlistentrydefinition.html deleted file mode 100644 index f0fd033..0000000 --- a/docs/interfaces/idestinyactivitygraphlistentrydefinition.html +++ /dev/null @@ -1,211 +0,0 @@ - - - - - - IDestinyActivityGraphListEntryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityGraphListEntryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Destinations and Activities may have default Activity Graphs that should be - shown when you bring up the Director and are playing in either.

        -
        -

        This contract defines the graph referred to and the gating for when it is - relevant.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityGraphListEntryDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activityGraphHash

        -
        activityGraphHash: number
        - -
        -
        -

        The hash identifier of the DestinyActivityGraphDefinition that should be shown - when opening the director.

        -
        -

        Mapped to IDestinyActivityGraphDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitygraphnodeactivitydefinition.html b/docs/interfaces/idestinyactivitygraphnodeactivitydefinition.html deleted file mode 100644 index 9cd75b9..0000000 --- a/docs/interfaces/idestinyactivitygraphnodeactivitydefinition.html +++ /dev/null @@ -1,235 +0,0 @@ - - - - - - IDestinyActivityGraphNodeActivityDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityGraphNodeActivityDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The actual activity to be redirected to when you click on the node. Note that a - node can have many Activities attached to it: but only one will be active at any - given time. The list of Node Activities will be traversed, and the first one - found to be active will be displayed. This way, a node can layer multiple - variants of an activity on top of each other. For instance, one node can control - the weekly Crucible Playlist. There are multiple possible playlists, but only - one is active for the week.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityGraphNodeActivityDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activityHash

        -
        activityHash: number
        - -
        -
        -

        The activity that will be activated if the user clicks on this node. Controls - all activity-related information displayed on the node if it is active (the text - shown in the tooltip etc)

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        nodeActivityId

        -
        nodeActivityId: number
        - -
        -
        -

        An identifier for this node activity. It is only guaranteed to be unique within - the Activity Graph.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitygraphnodedefinition.html b/docs/interfaces/idestinyactivitygraphnodedefinition.html deleted file mode 100644 index 70baa94..0000000 --- a/docs/interfaces/idestinyactivitygraphnodedefinition.html +++ /dev/null @@ -1,315 +0,0 @@ - - - - - - IDestinyActivityGraphNodeDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityGraphNodeDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This is the position and other data related to nodes in the activity graph that - you can click to launch activities. An Activity Graph node will only have one - active Activity at a time, which will determine the activity to be launched (and, - unless overrideDisplay information is provided, will also determine the tooltip - and other UI related to the node)

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityGraphNodeDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activities

        - - -
        -
        -

        The node may have various possible activities that could be active for it, - however only one may be active at a time. See the - DestinyActivityGraphNodeActivityDefinition for details.

        -
        -
        -
        -
        - -

        featuringStates

        - - -
        -
        -

        The node may have various visual accents placed on it, or styles applied. These - are the list of possible styles that the Node can have. The game iterates - through each, looking for the first one that passes a check of the required game/ - character/account state in order to show that style, and then renders the node - in that style.

        -
        -
        -
        -
        - -

        nodeId

        -
        nodeId: number
        - -
        -
        -

        An identifier for the Activity Graph Node, only guaranteed to be unique within - its parent Activity Graph.

        -
        -
        -
        -
        - -

        overrideDisplay

        - - -
        -
        -

        The node may have display properties that override the active Activity's - display properties.

        -
        -
        -
        -
        - -

        position

        - - -
        -
        -

        The position on the map for this node.

        -
        -
        -
        -
        - -

        states

        - - -
        -
        -

        Represents possible states that the graph node can be in. These are combined - with some checking that happens in the game client and server to determine which - state is actually active at any given time.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitygraphnodefeaturingstatedefinition.html b/docs/interfaces/idestinyactivitygraphnodefeaturingstatedefinition.html deleted file mode 100644 index e387359..0000000 --- a/docs/interfaces/idestinyactivitygraphnodefeaturingstatedefinition.html +++ /dev/null @@ -1,211 +0,0 @@ - - - - - - IDestinyActivityGraphNodeFeaturingStateDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityGraphNodeFeaturingStateDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Nodes can have different visual states. This object represents a single visual - state ("highlight type") that a node can be in, and the unlock expression - condition to determine whether it should be set.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityGraphNodeFeaturingStateDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        highlightType

        - - -
        -
        -

        The node can be highlighted in a variety of ways - the game iterates through - these and finds the first FeaturingState that is valid at the present moment - given the Game, Account, and Character state, and renders the node in that state. - See the ActivityGraphNodeHighlightType enum for possible values.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitygraphnodestateentry.html b/docs/interfaces/idestinyactivitygraphnodestateentry.html deleted file mode 100644 index 3064209..0000000 --- a/docs/interfaces/idestinyactivitygraphnodestateentry.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - - - IDestinyActivityGraphNodeStateEntry | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityGraphNodeStateEntry

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents a single state that a graph node might end up in. Depending on what's - going on in the game, graph nodes could be shown in different ways or even - excluded from view entirely.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityGraphNodeStateEntry -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        state

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivityguidedblockdefinition.html b/docs/interfaces/idestinyactivityguidedblockdefinition.html deleted file mode 100644 index 69ebf90..0000000 --- a/docs/interfaces/idestinyactivityguidedblockdefinition.html +++ /dev/null @@ -1,246 +0,0 @@ - - - - - - IDestinyActivityGuidedBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityGuidedBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Guided Game information for this activity.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityGuidedBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        guidedDisbandCount

        -
        guidedDisbandCount: number
        - -
        -
        -

        If -1, the guided group cannot be disbanded. Otherwise, take the total # of - players in the activity and subtract this number: that is the total # of votes - needed for the guided group to disband.

        -
        -
        -
        -
        - -

        guidedMaxLobbySize

        -
        guidedMaxLobbySize: number
        - -
        -
        -

        The maximum amount of people that can be in the waiting lobby.

        -
        -
        -
        -
        - -

        guidedMinLobbySize

        -
        guidedMinLobbySize: number
        - -
        -
        -

        The minimum amount of people that can be in the waiting lobby.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivityhistoryresults.html b/docs/interfaces/idestinyactivityhistoryresults.html deleted file mode 100644 index 9f31c8b..0000000 --- a/docs/interfaces/idestinyactivityhistoryresults.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - IDestinyActivityHistoryResults | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityHistoryResults

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityHistoryResults -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activities

        - - -
        -
        -

        List of activities, the most recent activity first.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivityinsertionpointdefinition.html b/docs/interfaces/idestinyactivityinsertionpointdefinition.html deleted file mode 100644 index 218b2db..0000000 --- a/docs/interfaces/idestinyactivityinsertionpointdefinition.html +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - IDestinyActivityInsertionPointDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityInsertionPointDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A point of entry into an activity, gated by an unlock flag and with some more-or- - less useless (for our purposes) phase information. I'm including it in case we - end up being able to bolt more useful information onto it in the future.

        -
        -

        UPDATE: Turns out this information isn't actually useless, and is in fact - actually useful for people. Who would have thought? We still don't have - localized info for it, but at least this will help people when they're looking - at phase indexes in stats data, or when they want to know what phases have been - completed on a weekly achievement.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityInsertionPointDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        phaseHash

        -
        phaseHash: number
        - -
        -
        -

        A unique hash value representing the phase. This can be useful for, for example, - comparing how different instances of Raids have phases in different orders!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivityloadoutrequirement.html b/docs/interfaces/idestinyactivityloadoutrequirement.html deleted file mode 100644 index 777609f..0000000 --- a/docs/interfaces/idestinyactivityloadoutrequirement.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - - IDestinyActivityLoadoutRequirement | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityLoadoutRequirement

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityLoadoutRequirement -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        allowedEquippedItemHashes

        -
        allowedEquippedItemHashes: number[]
        - -
        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        -
        - -

        allowedWeaponSubTypes

        -
        allowedWeaponSubTypes: DestinyItemSubType[]
        - -
        -
        - -

        equipmentSlotHash

        -
        equipmentSlotHash: number
        - -
        -
        -

        Mapped to IDestinyEquipmentSlotDefinition in the manifest.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivityloadoutrequirementset.html b/docs/interfaces/idestinyactivityloadoutrequirementset.html deleted file mode 100644 index 615d96a..0000000 --- a/docs/interfaces/idestinyactivityloadoutrequirementset.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - - IDestinyActivityLoadoutRequirementSet | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityLoadoutRequirementSet

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityLoadoutRequirementSet -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        requirements

        - - -
        -
        -

        The set of requirements that will be applied on the activity if this requirement - set is active.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitymatchmakingblockdefinition.html b/docs/interfaces/idestinyactivitymatchmakingblockdefinition.html deleted file mode 100644 index 2516f21..0000000 --- a/docs/interfaces/idestinyactivitymatchmakingblockdefinition.html +++ /dev/null @@ -1,283 +0,0 @@ - - - - - - IDestinyActivityMatchmakingBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityMatchmakingBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Information about matchmaking and party size for the activity.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityMatchmakingBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        isMatchmade

        -
        isMatchmade: boolean
        - -
        -
        -

        If TRUE, the activity is matchmade. Otherwise, it requires explicit forming of a - party.

        -
        -
        -
        -
        - -

        maxParty

        -
        maxParty: number
        - -
        -
        -

        The maximum # of people allowed in a Fireteam.

        -
        -
        -
        -
        - -

        maxPlayers

        -
        maxPlayers: number
        - -
        -
        -

        The maximum # of people allowed across all teams in the activity.

        -
        -
        -
        -
        - -

        minParty

        -
        minParty: number
        - -
        -
        -

        The minimum # of people in the fireteam for the activity to launch.

        -
        -
        -
        -
        - -

        requiresGuardianOath

        -
        requiresGuardianOath: boolean
        - -
        -
        -

        If true, you have to Solemnly Swear to be up to Nothing But Good(tm) to play.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitymodedefinition.html b/docs/interfaces/idestinyactivitymodedefinition.html deleted file mode 100644 index 0469a0a..0000000 --- a/docs/interfaces/idestinyactivitymodedefinition.html +++ /dev/null @@ -1,486 +0,0 @@ - - - - - - IDestinyActivityModeDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityModeDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This definition represents an "Activity Mode" as it exists in the Historical - Stats endpoints. An individual Activity Mode represents a collection of - activities that are played in a certain way. For example, Nightfall Strikes are - part of a "Nightfall" activity mode, and any activities played as the PVP mode " - Clash" are part of the "Clash activity mode.

        -
        -

        Activity modes are nested under each other in a hierarchy, so that if you ask - for - for example - "AllPvP", you will get any PVP activities that the user has - played, regardless of what specific PVP mode was being played.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityModeDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activityModeCategory

        -
        activityModeCategory: DestinyActivityModeCategory
        - -
        -
        -

        The type of play being performed in broad terms (PVP, PVE)

        -
        -
        -
        -
        - -

        activityModeMappings

        -
        activityModeMappings: object
        - -
        -
        -

        If this exists, the mode has specific Activities (referred to by the Key) that - should instead map to other Activity Modes when they are played. This was useful - in D1 for Private Matches, where we wanted to have Private Matches as an - activity mode while still referring to the specific mode being played.

        -
        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        display

        -
        display: boolean
        - -
        -
        -

        If FALSE, we want to ignore this type when we're showing activity modes in BNet - UI. It will still be returned in case 3rd parties want to use it for any purpose.

        -
        -
        -
        -
        - -

        displayProperties

        - - -
        -
        - -

        friendlyName

        -
        friendlyName: string
        - -
        -
        -

        A Friendly identifier you can use for referring to this Activity Mode. We really - only used this in our URLs, so... you know, take that for whatever it's worth.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        isAggregateMode

        -
        isAggregateMode: boolean
        - -
        -
        -

        If true, this mode is an aggregation of other, more specific modes rather than - being a mode in itself. This includes modes that group Features/Events rather - than Gameplay, such as Trials of The Nine: Trials of the Nine being an Event - that is interesting to see aggregate data for, but when you play the activities - within Trials of the Nine they are more specific activity modes such as Clash.

        -
        -
        -
        -
        - -

        isTeamBased

        -
        isTeamBased: boolean
        - -
        -
        -

        If True, this mode has oppositional teams fighting against each other rather - than "Free-For-All" or Co-operative modes of play.

        -
        -

        Note that Aggregate modes are never marked as team based, even if they happen to - be team based at the moment. At any time, an aggregate whose subordinates are - only team based could be changed so that one or more aren't team based, and then - this boolean won't make much sense (the aggregation would become "sometimes team - based"). Let's not deal with that right now.

        -
        -
        -
        - -

        modeType

        - - -
        -
        -

        The Enumeration value for this Activity Mode. Pass this identifier into Stats - endpoints to get aggregate stats for this mode.

        -
        -
        -
        -
        - -

        order

        -
        order: number
        - -
        -
        -

        The relative ordering of activity modes.

        -
        -
        -
        -
        - -

        parentHashes

        -
        parentHashes: number[]
        - -
        -
        -

        The hash identifiers of the DestinyActivityModeDefinitions that represent all of - the "parent" modes for this mode. For instance, the Nightfall Mode is also a - member of AllStrikes and AllPvE.

        -
        -
        -
        -
        - -

        pgcrImage

        -
        pgcrImage: string
        - -
        -
        -

        If this activity mode has a related PGCR image, this will be the path to said - image.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitymodifierdefinition.html b/docs/interfaces/idestinyactivitymodifierdefinition.html deleted file mode 100644 index 57553be..0000000 --- a/docs/interfaces/idestinyactivitymodifierdefinition.html +++ /dev/null @@ -1,263 +0,0 @@ - - - - - - IDestinyActivityModifierDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityModifierDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Modifiers - in Destiny 1, these were referred to as "Skulls" - are changes that - can be applied to an Activity.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityModifierDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitymodifierreferencedefinition.html b/docs/interfaces/idestinyactivitymodifierreferencedefinition.html deleted file mode 100644 index c536fe6..0000000 --- a/docs/interfaces/idestinyactivitymodifierreferencedefinition.html +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - IDestinyActivityModifierReferenceDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityModifierReferenceDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A reference to an Activity Modifier from another entity, such as an Activity ( - for now, just Activities).

        -
        -

        This defines some

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityModifierReferenceDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activityModifierHash

        -
        activityModifierHash: number
        - -
        -
        -

        The hash identifier for the DestinyActivityModifierDefinition referenced by this - activity.

        -
        -

        Mapped to IDestinyActivityModifierDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivityplaylistitemdefinition.html b/docs/interfaces/idestinyactivityplaylistitemdefinition.html deleted file mode 100644 index 4fd56ac..0000000 --- a/docs/interfaces/idestinyactivityplaylistitemdefinition.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - IDestinyActivityPlaylistItemDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityPlaylistItemDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If the activity is a playlist, this is the definition for a specific entry in - the playlist: a single possible combination of Activity and Activity Mode that - can be chosen.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityPlaylistItemDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activityHash

        -
        activityHash: number
        - -
        -
        -

        The hash identifier of the Activity that can be played. Use it to look up the - DestinyActivityDefinition.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        activityModeHashes

        -
        activityModeHashes: number[]
        - -
        -
        -

        The hash identifiers for Activity Modes relevant to this entry.

        -
        -

        Mapped to IDestinyActivityModeDefinition in the manifest.

        -
        -
        -
        - -

        activityModeTypes

        -
        activityModeTypes: DestinyActivityModeType[]
        - -
        -
        -

        The activity modes - if any - in enum form. Because we can't seem to escape the - enums.

        -
        -
        -
        -
        - -

        Optional directActivityModeHash

        -
        directActivityModeHash: number
        - -
        -
        -

        If this playlist entry had an activity mode directly defined on it, this will be - the hash of that mode.

        -
        -

        Mapped to IDestinyActivityModeDefinition in the manifest.

        -
        -
        -
        - -

        Optional directActivityModeType

        -
        directActivityModeType: number
        - -
        -
        -

        If the playlist entry had an activity mode directly defined on it, this will be - the enum value of that mode.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivityrewarddefinition.html b/docs/interfaces/idestinyactivityrewarddefinition.html deleted file mode 100644 index b5f458a..0000000 --- a/docs/interfaces/idestinyactivityrewarddefinition.html +++ /dev/null @@ -1,237 +0,0 @@ - - - - - - IDestinyActivityRewardDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityRewardDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Activities can refer to one or more sets of tooltip-friendly reward data. These - are the definitions for those tooltip friendly rewards.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityRewardDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        rewardItems

        -
        rewardItems: IDestinyItemQuantity[]
        - -
        -
        -

        The "Items provided" in the reward. This is almost always a pointer to a - DestinyInventoryItemDefintion for an item that you can't actually earn in-game, - but that has name/description/icon information for the vague concept of the - rewards you will receive. This is because the actual reward generation is non- - deterministic and extremely complicated, so the best the game can do is tell you - what you'll get in vague terms. And so too shall we.

        -
        -

        Interesting trivia: you actually do earn these items when you complete the - activity. They go into a single-slot bucket on your profile, which is how you - see the pop-ups of these rewards when you complete an activity that match these " - dummy" items. You can even see them if you look at the last one you earned in - your profile-level inventory through the BNet API! Who said reading - documentation is a waste of time?

        -
        -
        -
        - -

        rewardText

        -
        rewardText: string
        - -
        -
        -

        The header for the reward set, if any.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivitytypedefinition.html b/docs/interfaces/idestinyactivitytypedefinition.html deleted file mode 100644 index 2851994..0000000 --- a/docs/interfaces/idestinyactivitytypedefinition.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - IDestinyActivityTypeDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityTypeDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The definition for an Activity Type.

        -
        -

        In Destiny 2, an Activity Type represents a conceptual categorization of - Activities.

        -

        These are most commonly used in the game for the subtitle under Activities, but - BNet uses them extensively to identify and group activities by their common - properties.

        -

        Unfortunately, there has been a movement away from providing the richer data in - Destiny 2 that we used to get in Destiny 1 for Activity Types. For instance, - Nightfalls are grouped under the same Activity Type as regular Strikes.

        -

        For this reason, BNet will eventually migrate toward Activity Modes as a better - indicator of activity category. But for the time being, it is still referred to - in many places across our codebase.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityTypeDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyactivityunlockstringdefinition.html b/docs/interfaces/idestinyactivityunlockstringdefinition.html deleted file mode 100644 index 09cdefb..0000000 --- a/docs/interfaces/idestinyactivityunlockstringdefinition.html +++ /dev/null @@ -1,209 +0,0 @@ - - - - - - IDestinyActivityUnlockStringDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyActivityUnlockStringDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents a status string that could be conditionally displayed about an - activity. Note that externally, you can only see the strings themselves. - Internally we combine this information with server state to determine which - strings should be shown.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyActivityUnlockStringDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayString

        -
        displayString: string
        - -
        -
        -

        The string to be displayed if the conditions are met.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyaggregateactivityresults.html b/docs/interfaces/idestinyaggregateactivityresults.html deleted file mode 100644 index 7eb6c9a..0000000 --- a/docs/interfaces/idestinyaggregateactivityresults.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - IDestinyAggregateActivityResults | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyAggregateActivityResults

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyAggregateActivityResults -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activities

        - - -
        -
        -

        List of all activities the player has participated in.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyaggregateactivitystats.html b/docs/interfaces/idestinyaggregateactivitystats.html deleted file mode 100644 index 1b3953f..0000000 --- a/docs/interfaces/idestinyaggregateactivitystats.html +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - IDestinyAggregateActivityStats | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyAggregateActivityStats

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyAggregateActivityStats -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activityHash

        -
        activityHash: number
        - -
        -
        -

        Hash ID that can be looked up in the DestinyActivityTable.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        values

        -
        values: object
        - -
        -
        -

        Collection of stats for the player in this activity.

        -
        -
        -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyanimationreference.html b/docs/interfaces/idestinyanimationreference.html deleted file mode 100644 index bcd1123..0000000 --- a/docs/interfaces/idestinyanimationreference.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IDestinyAnimationReference | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyAnimationReference

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyAnimationReference -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        animIdentifier

        -
        animIdentifier: string
        - -
        -
        - -

        animName

        -
        animName: string
        - -
        -
        - -

        path

        -
        path: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyartdyereference.html b/docs/interfaces/idestinyartdyereference.html deleted file mode 100644 index 6f8e3e2..0000000 --- a/docs/interfaces/idestinyartdyereference.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - IDestinyArtDyeReference | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyArtDyeReference

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyArtDyeReference -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        artDyeChannelHash

        -
        artDyeChannelHash: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinybaseitemcomponentsetofuint32.html b/docs/interfaces/idestinybaseitemcomponentsetofuint32.html deleted file mode 100644 index e6615eb..0000000 --- a/docs/interfaces/idestinybaseitemcomponentsetofuint32.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - IDestinyBaseItemComponentSetOfuint32 | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyBaseItemComponentSetOfuint32

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyBaseItemComponentSetOfuint32 -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        objectives

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinybubbledefinition.html b/docs/interfaces/idestinybubbledefinition.html deleted file mode 100644 index 85d62a3..0000000 --- a/docs/interfaces/idestinybubbledefinition.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - - IDestinyBubbleDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyBubbleDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Basic identifying data about the bubble. Combine with - DestinyDestinationBubbleSettingDefinition - see DestinyDestinationDefinition. - bubbleSettings for more information.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyBubbleDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        -

        The display properties of this bubble, so you don't have to look them up in a - separate list anymore.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The identifier for the bubble: only guaranteed to be unique within the - Destination.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinychallengestatus.html b/docs/interfaces/idestinychallengestatus.html deleted file mode 100644 index 47cd934..0000000 --- a/docs/interfaces/idestinychallengestatus.html +++ /dev/null @@ -1,209 +0,0 @@ - - - - - - IDestinyChallengeStatus | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyChallengeStatus

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents the status and other related information for a challenge that is - or - was - available to a player.

        -
        -

        A challenge is a bonus objective, generally tacked onto Quests or Activities, - that provide additional variations on play.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyChallengeStatus -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        objective

        - - -
        -
        -

        The progress - including completion status - of the active challenge.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinycharacteractivitiescomponent.html b/docs/interfaces/idestinycharacteractivitiescomponent.html deleted file mode 100644 index 0e7247a..0000000 --- a/docs/interfaces/idestinycharacteractivitiescomponent.html +++ /dev/null @@ -1,376 +0,0 @@ - - - - - - IDestinyCharacterActivitiesComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyCharacterActivitiesComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This component holds activity data for a character. It will tell you about the - character's current activity status, as well as activities that are available to - the user.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyCharacterActivitiesComponent -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        availableActivities

        -
        availableActivities: IDestinyActivity[]
        - -
        -
        -

        The list of activities that the user can play.

        -
        -
        -
        -
        - -

        currentActivityHash

        -
        currentActivityHash: number
        - -
        -
        -

        If the user is in an activity, this will be the hash of the Activity being - played. Note that you must combine this info with currentActivityModeHash to get - a real picture of what the user is doing right now. For instance, PVP " - Activities" are just maps: it's the ActivityMode that determines what type of - PVP game they're playing.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        currentActivityModeHash

        -
        currentActivityModeHash: number
        - -
        -
        -

        If the user is in an activity, this will be the hash of the activity mode being - played. Combine with currentActivityHash to give a person a full picture of what - they're doing right now.

        -
        -

        Mapped to IDestinyActivityModeDefinition in the manifest.

        -
        -
        -
        - -

        currentActivityModeHashes

        -
        currentActivityModeHashes: number[]
        - -
        -
        -

        If the user is in an activity, this will be the hashes of the - DestinyActivityModeDefinition being played. Combine with currentActivityHash to - give a person a full picture of what they're doing right now.

        -
        -

        Mapped to IDestinyActivityModeDefinition in the manifest.

        -
        -
        -
        - -

        Optional currentActivityModeType

        -
        currentActivityModeType: number
        - -
        -
        -

        And the current activity's most specific mode type, if it can be found.

        -
        -

        Mapped to IDestinyActivityModeDefinition in the manifest.

        -
        -
        -
        - -

        currentActivityModeTypes

        -
        currentActivityModeTypes: DestinyActivityModeType[]
        - -
        -
        -

        All Activity Modes that apply to the current activity being played, in enum form.

        -
        -
        -
        -
        - -

        Optional currentPlaylistActivityHash

        -
        currentPlaylistActivityHash: number
        - -
        -
        -

        If the user is in a playlist, this is the hash identifier for the playlist that - they chose.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        dateActivityStarted

        -
        dateActivityStarted: string
        - -
        -
        -

        The last date that the user started playing an activity.

        -
        -
        -
        -
        - -

        lastCompletedStoryHash

        -
        lastCompletedStoryHash: number
        - -
        -
        -

        This will have the activity hash of the last completed story/campaign mission, - in case you care about that.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinycharactercomponent.html b/docs/interfaces/idestinycharactercomponent.html deleted file mode 100644 index 87f4769..0000000 --- a/docs/interfaces/idestinycharactercomponent.html +++ /dev/null @@ -1,648 +0,0 @@ - - - - - - IDestinyCharacterComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyCharacterComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This component contains base properties of the character. You'll probably want - to always request this component, but hey you do you.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyCharacterComponent -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        baseCharacterLevel

        -
        baseCharacterLevel: number
        - -
        -
        -

        The "base" level of your character, not accounting for any light level.

        -
        -
        -
        -
        - -

        characterId

        -
        characterId: string
        - -
        -
        -

        The unique identifier for the character.

        -
        -
        -
        -
        - -

        classHash

        -
        classHash: number
        - -
        -
        -

        Use this hash to look up the character's DestinyClassDefinition.

        -
        -

        Mapped to IDestinyClassDefinition in the manifest.

        -
        -
        -
        - -

        classType

        -
        classType: DestinyClass
        - -
        -
        -

        Mostly for historical purposes at this point, this is an enumeration for the - character's class.

        -
        -

        It'll be preferable in the general case to look up the related definition: but - for some people this was too convenient to remove.

        -
        -
        -
        - -

        dateLastPlayed

        -
        dateLastPlayed: string
        - -
        -
        -

        The last date that the user played Destiny.

        -
        -
        -
        -
        - -

        emblemBackgroundPath

        -
        emblemBackgroundPath: string
        - -
        -
        -

        A shortcut path to the user's currently equipped emblem background image. If you' - re just showing summary info for a user, this is more convenient than examining - their equipped emblem and looking up the definition.

        -
        -
        -
        -
        - -

        emblemColor

        -
        emblemColor: IDestinyColor
        - -
        -
        -

        A shortcut for getting the background color of the user's currently equipped - emblem without having to do a DestinyInventoryItemDefinition lookup.

        -
        -
        -
        -
        - -

        emblemHash

        -
        emblemHash: number
        - -
        -
        -

        The hash of the currently equipped emblem for the user. Can be used to look up - the DestinyInventoryItemDefinition.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        emblemPath

        -
        emblemPath: string
        - -
        -
        -

        A shortcut path to the user's currently equipped emblem image. If you're just - showing summary info for a user, this is more convenient than examining their - equipped emblem and looking up the definition.

        -
        -
        -
        -
        - -

        genderHash

        -
        genderHash: number
        - -
        -
        -

        Use this hash to look up the character's DestinyGenderDefinition.

        -
        -

        Mapped to IDestinyGenderDefinition in the manifest.

        -
        -
        -
        - -

        genderType

        -
        genderType: DestinyGender
        - -
        -
        -

        Mostly for historical purposes at this point, this is an enumeration for the - character's Gender.

        -
        -

        It'll be preferable in the general case to look up the related definition: but - for some people this was too convenient to remove. And yeah, it's an enumeration - and not a boolean. Fight me.

        -
        -
        -
        - -

        levelProgression

        -
        levelProgression: IDestinyProgression
        - -
        -
        -

        The progression that indicates your character's level. Not their light level, - but their character level: you know, the thing you max out a couple hours in and - then ignore for the sake of light level.

        -
        -
        -
        -
        - -

        light

        -
        light: number
        - -
        -
        -

        The user's calculated "Light Level". Light level is an indicator of your power - that mostly matters in the end game, once you've reached the maximum character - level: it's a level that's dependent on the average Attack/Defense power of your - items.

        -
        -
        -
        -
        - -

        membershipId

        -
        membershipId: string
        - -
        -
        -

        Every Destiny Profile has a membershipId. This is provided on the character as - well for convenience.

        -
        -
        -
        -
        - -

        membershipType

        -
        membershipType: BungieMembershipType
        - -
        -
        -

        membershipType tells you the platform on which the character plays. Examine the - BungieMembershipType enumeration for possible values.

        -
        -
        -
        -
        - -

        minutesPlayedThisSession

        -
        minutesPlayedThisSession: string
        - -
        -
        -

        If the user is currently playing, this is how long they've been playing.

        -
        -
        -
        -
        - -

        minutesPlayedTotal

        -
        minutesPlayedTotal: string
        - -
        -
        -

        If this value is 525,600, then they played Destiny for a year. Or they're a very - dedicated Rent fan. Note that this includes idle time, not just time spent - actually in activities shooting things.

        -
        -
        -
        -
        - -

        percentToNextLevel

        -
        percentToNextLevel: number
        - -
        -
        -

        A number between 0 and 100, indicating the whole and fractional % remaining to - get to the next character level.

        -
        -
        -
        -
        - -

        raceHash

        -
        raceHash: number
        - -
        -
        -

        Use this hash to look up the character's DestinyRaceDefinition.

        -
        -

        Mapped to IDestinyRaceDefinition in the manifest.

        -
        -
        -
        - -

        raceType

        -
        raceType: DestinyRace
        - -
        -
        -

        Mostly for historical purposes at this point, this is an enumeration for the - character's race.

        -
        -

        It'll be preferable in the general case to look up the related definition: but - for some people this was too convenient to remove.

        -
        -
        -
        - -

        stats

        -
        stats: object
        - -
        -
        -

        Your character's stats, such as Agility, Resilience, etc... not historical - stats.

        -
        -

        You'll have to call a different endpoint for those.

        -
        -
        -

        Type declaration

        -
          -
        • -
          [key: number]: number
          -
        • -
        -
        -
        -
        - -

        Optional titleRecordHash

        -
        titleRecordHash: number
        - -
        -
        -

        If this Character has a title assigned to it, this is the identifier of the - DestinyRecordDefinition that has that title information.

        -
        -

        Mapped to IDestinyRecordDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinycharactercustomization.html b/docs/interfaces/idestinycharactercustomization.html deleted file mode 100644 index 340eb7c..0000000 --- a/docs/interfaces/idestinycharactercustomization.html +++ /dev/null @@ -1,362 +0,0 @@ - - - - - - IDestinyCharacterCustomization | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyCharacterCustomization

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Raw data about the customization options chosen for a character's face and - appearance.

        -
        -

        You can look up the relevant class/race/gender combo in - DestinyCharacterCustomizationOptionDefinition for the character, and then look - up these values within the CustomizationOptions found to pull some data about - their choices. Warning: not all of that data is meaningful. Some data has useful - icons. Others have nothing, and are only meant for 3D rendering purposes (which - we sadly do not expose yet)

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyCharacterCustomization -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        decalColor

        -
        decalColor: number
        - -
        -
        - -

        decalIndex

        -
        decalIndex: number
        - -
        -
        - -

        eyeColor

        -
        eyeColor: number
        - -
        -
        - -

        face

        -
        face: number
        - -
        -
        - -

        featureColors

        -
        featureColors: number[]
        - -
        -
        - -

        featureIndex

        -
        featureIndex: number
        - -
        -
        - -

        hairColors

        -
        hairColors: number[]
        - -
        -
        - -

        hairIndex

        -
        hairIndex: number
        - -
        -
        - -

        lipColor

        -
        lipColor: number
        - -
        -
        - -

        personality

        -
        personality: number
        - -
        -
        - -

        skinColor

        -
        skinColor: number
        - -
        -
        - -

        wearHelmet

        -
        wearHelmet: boolean
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinycharacterpeerview.html b/docs/interfaces/idestinycharacterpeerview.html deleted file mode 100644 index b0f8b1a..0000000 --- a/docs/interfaces/idestinycharacterpeerview.html +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - IDestinyCharacterPeerView | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyCharacterPeerView

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A minimal view of a character's equipped items, for the purpose of rendering a - summary screen or showing the character in 3D.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyCharacterPeerView -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        equipment

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinycharacterprogressioncomponent.html b/docs/interfaces/idestinycharacterprogressioncomponent.html deleted file mode 100644 index ab2c124..0000000 --- a/docs/interfaces/idestinycharacterprogressioncomponent.html +++ /dev/null @@ -1,369 +0,0 @@ - - - - - - IDestinyCharacterProgressionComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyCharacterProgressionComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This component returns anything that could be considered "Progression" on a user: - data where the user is gaining levels, reputation, completions, rewards, etc...

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyCharacterProgressionComponent -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        checklists

        -
        checklists: object
        - -
        -
        -

        The set of checklists that can be examined for this specific character, keyed by - the hash identifier of the Checklist (DestinyChecklistDefinition)

        -
        -

        For each checklist returned, its value is itself a Dictionary keyed by the - checklist's hash identifier with the value being a boolean indicating if it's - been discovered yet.

        -

        Mapped to IDestinyChecklistDefinition in the manifest.

        -
        -
        -

        Type declaration

        -
          -
        • -
          [key: number]: object
          -
            -
          • -
            [key: number]: boolean
            -
          • -
          -
        • -
        -
        -
        -
        - -

        factions

        -
        factions: object
        - -
        -
        -

        A dictionary of all known Factions, keyed by the Faction's hash. It contains - data about this character's status with the faction.

        -
        -

        Mapped to IDestinyFactionDefinition in the manifest.

        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        milestones

        -
        milestones: object
        - -
        -
        -

        Milestones are related to the simple progressions shown in the game, but return - additional and hopefully helpful information for users about the specifics of - the Milestone's status.

        -
        -

        Mapped to IDestinyMilestoneDefinition in the manifest.

        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        progressions

        -
        progressions: object
        - -
        -
        -

        A Dictionary of all known progressions for the Character, keyed by the - Progression's hash.

        -
        -

        Not all progressions have user-facing data, but those who do will have that data - contained in the DestinyProgressionDefinition.

        -

        Mapped to IDestinyProgressionDefinition in the manifest.

        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        quests

        - - -
        -
        -

        If the user has any active quests, the quests' statuses will be returned here.

        -
        -

        Note that quests have been largely supplanted by Milestones, but that doesn't - mean that they won't make a comeback independent of milestones at some point.

        -
        -
        -
        - -

        uninstancedItemObjectives

        -
        uninstancedItemObjectives: object
        - -
        -
        -

        Sometimes, you have items in your inventory that don't have instances, but still - have Objective information. This provides you that objective information for - uninstanced items.

        -
        -

        This dictionary is keyed by the item's hash: which you can use to look up the - name and description for the overall task(s) implied by the objective. The value - is the list of objectives for this item, and their statuses.

        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinycharacterrecordscomponent.html b/docs/interfaces/idestinycharacterrecordscomponent.html deleted file mode 100644 index 91b6ed0..0000000 --- a/docs/interfaces/idestinycharacterrecordscomponent.html +++ /dev/null @@ -1,221 +0,0 @@ - - - - - - IDestinyCharacterRecordsComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyCharacterRecordsComponent

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyCharacterRecordsComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        featuredRecordHashes

        -
        featuredRecordHashes: number[]
        - -
        -
        -

        Mapped to IDestinyRecordDefinition in the manifest.

        -
        -
        -
        -
        - -

        records

        -
        records: object
        - -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinycharacterrendercomponent.html b/docs/interfaces/idestinycharacterrendercomponent.html deleted file mode 100644 index 46615cc..0000000 --- a/docs/interfaces/idestinycharacterrendercomponent.html +++ /dev/null @@ -1,263 +0,0 @@ - - - - - - IDestinyCharacterRenderComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyCharacterRenderComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Only really useful if you're attempting to render the character's current - appearance in 3D, this returns a bare minimum of information, pre-aggregated, - that you'll need to perform that rendering. Note that you need to combine this - with other 3D assets and data from our servers.

        -
        -

        Examine the Javascript returned by https://bungie.net/sharedbundle/spasm to see - how we use this data, but be warned: the rabbit hole goes pretty deep.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyCharacterRenderComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        customDyes

        -
        customDyes: IDyeReference[]
        - -
        -
        -

        Custom dyes, calculated by iterating over the character's equipped items. Useful - for pre-fetching all of the dye data needed from our server.

        -
        -
        -
        -
        - -

        customization

        - - -
        -
        -

        This is actually something that Spasm.js doesn't do right now, and that we don' - t return assets for yet. This is the data about what character customization - options you picked. You can combine this with - DestinyCharacterCustomizationOptionDefinition to show some cool info, and - hopefully someday to actually render a user's face in 3D. We'll see if we ever - end up with time for that.

        -
        -
        -
        -
        - -

        peerView

        - - -
        -
        -

        A minimal view of:

        -
        -
          -
        • Equipped items

          -
        • -
        • The rendering-related custom options on those equipped items

          -
        • -
        -

        Combined, that should be enough to render all of the items on the equipped - character.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinycharacterresponse.html b/docs/interfaces/idestinycharacterresponse.html deleted file mode 100644 index d874c1c..0000000 --- a/docs/interfaces/idestinycharacterresponse.html +++ /dev/null @@ -1,474 +0,0 @@ - - - - - - IDestinyCharacterResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyCharacterResponse

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The response contract for GetDestinyCharacter, with components that can be - returned for character and item-level data.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyCharacterResponse -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activities

        - - -
        -
        -

        Activity data - info about current activities available to the player.

        -
        -

        COMPONENT TYPE: CharacterActivities

        -
        -
        -
        - -

        character

        - - -
        -
        -

        Base information about the character in question.

        -
        -

        COMPONENT TYPE: Characters

        -
        -
        -
        - -

        collectibles

        - - -
        -
        -

        COMPONENT TYPE: Collectibles

        -
        -
        -
        -
        - -

        currencyLookups

        - - -
        -
        -

        A "lookup" convenience component that can be used to quickly check if the - character has access to items that can be used for purchasing.

        -
        -

        COMPONENT TYPE: CurrencyLookups

        -
        -
        -
        - -

        equipment

        - - -
        -
        -

        Equipped items on the character.

        -
        -

        COMPONENT TYPE: CharacterEquipment

        -
        -
        -
        - -

        inventory

        - - -
        -
        -

        The character-level non-equipped inventory items.

        -
        -

        COMPONENT TYPE: CharacterInventories

        -
        -
        -
        - -

        itemComponents

        - - -
        -
        -

        The set of components belonging to the player's instanced items.

        -
        -

        COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component - types.]

        -
        -
        -
        - -

        kiosks

        - - -
        -
        -

        Items available from Kiosks that are available to this specific character.

        -
        -

        COMPONENT TYPE: Kiosks

        -
        -
        -
        - -

        plugSets

        - - -
        -
        -

        When sockets refer to reusable Plug Sets (see DestinyPlugSetDefinition for more - info), this is the set of plugs and their states that are scoped to this - character.

        -
        -

        This comes back with ItemSockets, as it is needed for a complete picture of the - sockets on requested items.

        -

        COMPONENT TYPE: ItemSockets

        -
        -
        -
        - -

        presentationNodes

        - - -
        -
        -

        COMPONENT TYPE: PresentationNodes

        -
        -
        -
        -
        - -

        progressions

        - - -
        -
        -

        Character progression data, including Milestones.

        -
        -

        COMPONENT TYPE: CharacterProgressions

        -
        -
        -
        - -

        records

        - - -
        -
        -

        COMPONENT TYPE: Records

        -
        -
        -
        -
        - -

        renderData

        - - -
        -
        -

        Character rendering data - a minimal set of information about equipment and dyes - used for rendering.

        -
        -

        COMPONENT TYPE: CharacterRenderData

        -
        -
        -
        - -

        uninstancedItemComponents

        -
        uninstancedItemComponents: IDestinyBaseItemComponentSetOfuint32
        - -
        -
        -

        The set of components belonging to the player's UNinstanced items. Because - apparently now those too can have information relevant to the character's state.

        -
        -

        COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component - types.]

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinychecklistdefinition.html b/docs/interfaces/idestinychecklistdefinition.html deleted file mode 100644 index 1648381..0000000 --- a/docs/interfaces/idestinychecklistdefinition.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - - IDestinyChecklistDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyChecklistDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        By public demand, Checklists are loose sets of "things to do/things you have - done" in Destiny that we were actually able to track. They include easter eggs - you find in the world, unique chests you unlock, and other such data where the - first time you do it is significant enough to be tracked, and you have the - potential to "get them all".

        -
        -

        These may be account-wide, or may be per character. The status of these will be - returned in related "Checklist" data coming down from API requests such as - GetProfile or GetCharacter.

        -

        Generally speaking, the items in a checklist can be completed in any order: we - return an ordered list which only implies the way we are showing them in our own - UI, and you can feel free to alter it as you wish.

        -

        Note that, in the future, there will be something resembling the old D1 Record - Books in at least some vague form. When that is created, it may be that it will - supercede much or all of this Checklist data. It remains to be seen if that will - be the case, so for now assume that the Checklists will still exist even after - the release of D2: Forsaken.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyChecklistDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        - -

        entries

        - - -
        -
        -

        The individual checklist items. Gotta catch 'em all.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        scope

        - - -
        -
        -

        Indicates whether you will find this checklist on the Profile or Character - components.

        -
        -
        -
        -
        - -

        viewActionString

        -
        viewActionString: string
        - -
        -
        -

        A localized string prompting you to view the checklist.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinychecklistentrydefinition.html b/docs/interfaces/idestinychecklistentrydefinition.html deleted file mode 100644 index 7465923..0000000 --- a/docs/interfaces/idestinychecklistentrydefinition.html +++ /dev/null @@ -1,380 +0,0 @@ - - - - - - IDestinyChecklistEntryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyChecklistEntryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The properties of an individual checklist item. Note that almost everything is - optional: it is highly variable what kind of data we'll actually be able to - return: at times we may have no other relationships to entities at all.

        -
        -

        Whatever UI you build, do it with the knowledge that any given entry might not - actually be able to be associated with some other Destiny entity.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyChecklistEntryDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        Optional activityHash

        -
        activityHash: number
        - -
        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        -
        - -

        Optional bubbleHash

        -
        bubbleHash: number
        - -
        -
        -

        Note that a Bubble's hash doesn't uniquely identify a "top level" entity in - Destiny. Only the combination of location and bubble can uniquely identify a - place in the world of Destiny: so if bubbleHash is populated, locationHash must - too be populated for it to have any meaning.

        -
        -

        You can use this property if it is populated to look up the - DestinyLocationDefinition's associated .locationReleases[].activityBubbleName - property.

        -
        -
        -
        - -

        Optional destinationHash

        -
        destinationHash: number
        - -
        -
        -

        Mapped to IDestinyDestinationDefinition in the manifest.

        -
        -
        -
        -
        - -

        displayProperties

        - - -
        -
        -

        Even if no other associations exist, we will give you something for display - properties. In cases where we have no associated entities, it may be as simple - as a numerical identifier.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The identifier for this Checklist entry. Guaranteed unique only within this - Checklist Definition, and not globally/for all checklists.

        -
        -
        -
        -
        - -

        Optional itemHash

        -
        itemHash: number
        - -
        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        -
        - -

        Optional locationHash

        -
        locationHash: number
        - -
        -
        -

        Mapped to IDestinyLocationDefinition in the manifest.

        -
        -
        -
        -
        - -

        scope

        - - -
        -
        -

        The scope at which this specific entry can be computed.

        -
        -
        -
        -
        - -

        Optional vendorHash

        -
        vendorHash: number
        - -
        -
        - -

        Optional vendorInteractionIndex

        -
        vendorInteractionIndex: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyclanaggregatestat.html b/docs/interfaces/idestinyclanaggregatestat.html deleted file mode 100644 index 70ccf17..0000000 --- a/docs/interfaces/idestinyclanaggregatestat.html +++ /dev/null @@ -1,237 +0,0 @@ - - - - - - IDestinyClanAggregateStat | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyClanAggregateStat

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyClanAggregateStat -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        mode

        - - -
        -
        -

        The id of the mode of stats (allPvp, allPvE, etc)

        -
        -
        -
        -
        - -

        statId

        -
        statId: string
        - -
        -
        -

        The id of the stat

        -
        -
        -
        -
        - -

        value

        - - -
        -
        -

        Value of the stat for this player

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyclassdefinition.html b/docs/interfaces/idestinyclassdefinition.html deleted file mode 100644 index d2ef1c7..0000000 --- a/docs/interfaces/idestinyclassdefinition.html +++ /dev/null @@ -1,359 +0,0 @@ - - - - - - IDestinyClassDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyClassDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Defines a Character Class in Destiny 2. These are types of characters you can - play, like Titan, Warlock, and Hunter.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyClassDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        classType

        -
        classType: DestinyClass
        - -
        -
        -

        In Destiny 1, we added a convenience Enumeration for referring to classes. We've - kept it, though mostly for posterity. This is the enum value for this definition' - s class.

        -
        -
        -
        -
        - -

        displayProperties

        - - -
        -
        - -

        genderedClassNames

        -
        genderedClassNames: object
        - -
        -
        -

        A localized string referring to the singular form of the Class's name when - referred to in gendered form. Keyed by the DestinyGender.

        -
        -
        -
        -

        Type declaration

        -
          -
        • -
          [key: number]: string
          -
        • -
        -
        -
        -
        - -

        genderedClassNamesByGenderHash

        -
        genderedClassNamesByGenderHash: object
        - -
        -
        -

        Mapped to IDestinyGenderDefinition in the manifest.

        -
        -
        -
        -

        Type declaration

        -
          -
        • -
          [key: number]: string
          -
        • -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        Optional mentorVendorHash

        -
        mentorVendorHash: number
        - -
        -
        -

        Mentors don't really mean anything anymore. Don't expect this to be populated.

        -
        -

        Mapped to IDestinyVendorDefinition in the manifest.

        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinycollectibleacquisitionblock.html b/docs/interfaces/idestinycollectibleacquisitionblock.html deleted file mode 100644 index 661e616..0000000 --- a/docs/interfaces/idestinycollectibleacquisitionblock.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - - IDestinyCollectibleAcquisitionBlock | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyCollectibleAcquisitionBlock

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyCollectibleAcquisitionBlock -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        Optional acquireMaterialRequirementHash

        -
        acquireMaterialRequirementHash: number
        - -
        -
        -

        Mapped to IDestinyMaterialRequirementSetDefinition in the manifest.

        -
        -
        -
        -
        - -

        Optional acquireTimestampUnlockValueHash

        -
        acquireTimestampUnlockValueHash: number
        - -
        -
        -

        Mapped to IDestinyUnlockValueDefinition in the manifest.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinycollectiblecomponent.html b/docs/interfaces/idestinycollectiblecomponent.html deleted file mode 100644 index f793ea7..0000000 --- a/docs/interfaces/idestinycollectiblecomponent.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - IDestinyCollectibleComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyCollectibleComponent

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyCollectibleComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        state

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinycollectibledefinition.html b/docs/interfaces/idestinycollectibledefinition.html deleted file mode 100644 index 53604ba..0000000 --- a/docs/interfaces/idestinycollectibledefinition.html +++ /dev/null @@ -1,387 +0,0 @@ - - - - - - IDestinyCollectibleDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyCollectibleDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Defines a

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyCollectibleDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        acquisitionInfo

        - - -
        -
        - -

        displayProperties

        - - -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        itemHash

        -
        itemHash: number
        - -
        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        -
        - -

        presentationInfo

        - - -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        scope

        - - -
        -
        -

        Indicates whether this Collectible's state is determined on a per-character or - on an account-wide basis.

        -
        -
        -
        -
        - -

        Optional sourceHash

        -
        sourceHash: number
        - -
        -
        -

        This is a hash identifier we are building on the BNet side in an attempt to let - people group collectibles by similar sources.

        -
        -

        I can't promise that it's going to be 100% accurate, but if the designers were - consistent in assigning the same source strings to items with the same sources, - it ought to be. No promises though.

        -

        This hash also doesn't relate to an actual definition, just to note: we've got - nothing useful other than the source string for this data.

        -
        -
        -
        - -

        sourceString

        -
        sourceString: string
        - -
        -
        -

        A human readable string for a hint about how to acquire the item.

        -
        -
        -
        -
        - -

        stateInfo

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinycollectiblenodedetailresponse.html b/docs/interfaces/idestinycollectiblenodedetailresponse.html deleted file mode 100644 index 4b15f41..0000000 --- a/docs/interfaces/idestinycollectiblenodedetailresponse.html +++ /dev/null @@ -1,238 +0,0 @@ - - - - - - IDestinyCollectibleNodeDetailResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyCollectibleNodeDetailResponse

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Returns the detailed information about a Collectible Presentation Node and any - Collectibles that are direct descendants.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyCollectibleNodeDetailResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        collectibleItemComponents

        -
        collectibleItemComponents: IDestinyItemComponentSetOfuint32
        - -
        -
        -

        Item components, keyed by the item hash of the items pointed at collectibles - found under the requested Presentation Node.

        -
        -

        NOTE: I had a lot of hemming and hawing about whether these should be keyed by - collectible hash or item hash... but ultimately having it be keyed by item hash - meant that UI that already uses DestinyItemComponentSet data wouldn't have to - have a special override to do the collectible -> item lookup once you delve into - an item's details, and it also meant that you didn't have to remember that the - Hash being used as the key for plugSets was different from the Hash being used - for the other Dictionaries. As a result, using the Item Hash felt like the least - crappy solution.

        -

        We may all come to regret this decision. We will see.

        -

        COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component - types.]

        -
        -
        -
        - -

        collectibles

        - - -
        -
        -

        COMPONENT TYPE: Collectibles

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinycollectiblescomponent.html b/docs/interfaces/idestinycollectiblescomponent.html deleted file mode 100644 index f4a761f..0000000 --- a/docs/interfaces/idestinycollectiblescomponent.html +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - IDestinyCollectiblesComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyCollectiblesComponent

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyCollectiblesComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        collectibles

        -
        collectibles: object
        - -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinycollectiblestateblock.html b/docs/interfaces/idestinycollectiblestateblock.html deleted file mode 100644 index 2d7c10c..0000000 --- a/docs/interfaces/idestinycollectiblestateblock.html +++ /dev/null @@ -1,213 +0,0 @@ - - - - - - IDestinyCollectibleStateBlock | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyCollectibleStateBlock

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyCollectibleStateBlock -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        Optional obscuredOverrideItemHash

        -
        obscuredOverrideItemHash: number
        - -
        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        -
        - -

        requirements

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinycolor.html b/docs/interfaces/idestinycolor.html deleted file mode 100644 index 9428868..0000000 --- a/docs/interfaces/idestinycolor.html +++ /dev/null @@ -1,244 +0,0 @@ - - - - - - IDestinyColor | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyColor

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents a color whose RGBA values are all represented as values between 0 and - 255.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyColor -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        alpha

        -
        alpha: number
        - -
        -
        - -

        blue

        -
        blue: number
        - -
        -
        - -

        green

        -
        green: number
        - -
        -
        - -

        red

        -
        red: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinycurrenciescomponent.html b/docs/interfaces/idestinycurrenciescomponent.html deleted file mode 100644 index 88d9ca6..0000000 --- a/docs/interfaces/idestinycurrenciescomponent.html +++ /dev/null @@ -1,228 +0,0 @@ - - - - - - IDestinyCurrenciesComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyCurrenciesComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This component provides a quick lookup of every item the requested character has - and how much of that item they have.

        -
        -

        Requesting this component will allow you to circumvent manually putting together - the list of which currencies you have for the purpose of testing currency - requirements on an item being purchased, or operations that have costs.

        -

        You could figure this out yourself by doing a GetCharacter or GetProfile - request and forming your own lookup table, but that is inconvenient enough that - this feels like a worthwhile (and optional) redundency. Don't bother requesting - it if you have already created your own lookup from prior GetCharacter/ - GetProfile calls.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyCurrenciesComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        itemQuantities

        -
        itemQuantities: object
        - -
        -
        -

        A dictionary - keyed by the item's hash identifier ( - DestinyInventoryItemDefinition), and whose value is the amount of that item you - have across all available inventory buckets for purchasing.

        -
        -

        This allows you to see whether the requesting character can afford any given - purchase/action without having to re-create this list itself.

        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -

        Type declaration

        -
          -
        • -
          [key: number]: number
          -
        • -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinydamagetypedefinition.html b/docs/interfaces/idestinydamagetypedefinition.html deleted file mode 100644 index 42f30d0..0000000 --- a/docs/interfaces/idestinydamagetypedefinition.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - IDestinyDamageTypeDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyDamageTypeDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        All damage types that are possible in the game are defined here, along with - localized info and icons as needed.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyDamageTypeDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        -

        The description of the damage type, icon etc...

        -
        -
        -
        -
        - -

        enumValue

        -
        enumValue: DamageType
        - -
        -
        -

        We have an enumeration for damage types for quick reference. This is the current - definition's damage type enum value.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        showIcon

        -
        showIcon: boolean
        - -
        -
        -

        If TRUE, the game shows this damage type's icon. Otherwise, it doesn't. Whether - you show it or not is up to you.

        -
        -
        -
        -
        - -

        transparentIconPath

        -
        transparentIconPath: string
        - -
        -
        -

        A variant of the icon that is transparent and colorless.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinydefinition.html b/docs/interfaces/idestinydefinition.html deleted file mode 100644 index 072e7f4..0000000 --- a/docs/interfaces/idestinydefinition.html +++ /dev/null @@ -1,248 +0,0 @@ - - - - - - IDestinyDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Provides common properties for destiny definitions.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyderiveditemcategorydefinition.html b/docs/interfaces/idestinyderiveditemcategorydefinition.html deleted file mode 100644 index dcd90a8..0000000 --- a/docs/interfaces/idestinyderiveditemcategorydefinition.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - IDestinyDerivedItemCategoryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyDerivedItemCategoryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A shortcut for the fact that some items have a "Preview Vendor" - See - DestinyInventoryItemDefinition.preview.previewVendorHash - that is intended to - be used to show what items you can get as a result of acquiring or using this - item.

        -
        -

        A common example of this in Destiny 1 was Eververse "Boxes," which could have - many possible items. This "Preview Vendor" is not a vendor you can actually see - in the game, but it defines categories and sale items for all of the possible - items you could get from the Box so that the game can show them to you. We - summarize that info here so that you don't have to do that Vendor lookup and - aggregation manually.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyDerivedItemCategoryDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        categoryDescription

        -
        categoryDescription: string
        - -
        -
        -

        The localized string for the category title. This will be something describing - the items you can get as a group, or your likelihood/the quantity you'll get.

        -
        -
        -
        -
        - -

        items

        - - -
        -
        -

        This is the list of all of the items for this category and the basic properties - we'll know about them.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyderiveditemdefinition.html b/docs/interfaces/idestinyderiveditemdefinition.html deleted file mode 100644 index e1f516e..0000000 --- a/docs/interfaces/idestinyderiveditemdefinition.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - - IDestinyDerivedItemDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyDerivedItemDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This is a reference to, and summary data for, a specific item that you can get - as a result of Using or Acquiring some other Item (For example, this could be - summary information for an Emote that you can get by opening an an Eververse Box) - See DestinyDerivedItemCategoryDefinition for more information.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyDerivedItemDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        iconPath

        -
        iconPath: string
        - -
        -
        -

        An icon for the item.

        -
        -
        -
        -
        - -

        itemDescription

        -
        itemDescription: string
        - -
        -
        -

        A brief description of the item.

        -
        -
        -
        -
        - -

        itemDetail

        -
        itemDetail: string
        - -
        -
        -

        Additional details about the derived item, in addition to the description.

        -
        -
        -
        -
        - -

        Optional itemHash

        -
        itemHash: number
        - -
        -
        -

        The hash for the DestinyInventoryItemDefinition of this derived item, if there - is one. Sometimes we are given this information as a manual override, in which - case there won't be an actual DestinyInventoryItemDefinition for what we display, - but you can still show the strings from this object itself.

        -
        -
        -
        -
        - -

        itemName

        -
        itemName: string
        - -
        -
        -

        The name of the derived item.

        -
        -
        -
        -
        - -

        vendorItemIndex

        -
        vendorItemIndex: number
        - -
        -
        -

        If the item was derived from a "Preview Vendor", this will be an index into the - DestinyVendorDefinition's itemList property. Otherwise, -1.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinydestinationbubblesettingdefinition.html b/docs/interfaces/idestinydestinationbubblesettingdefinition.html deleted file mode 100644 index 586ac2e..0000000 --- a/docs/interfaces/idestinydestinationbubblesettingdefinition.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - - - IDestinyDestinationBubbleSettingDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyDestinationBubbleSettingDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Human readable data about the bubble. Combine with DestinyBubbleDefinition - see - DestinyDestinationDefinition.bubbleSettings for more information.

        -
        -

        DEPRECATED - Just use bubbles.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyDestinationBubbleSettingDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinydestinationdefinition.html b/docs/interfaces/idestinydestinationdefinition.html deleted file mode 100644 index 473402f..0000000 --- a/docs/interfaces/idestinydestinationdefinition.html +++ /dev/null @@ -1,379 +0,0 @@ - - - - - - IDestinyDestinationDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyDestinationDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        On to one of the more confusing subjects of the API. What is a Destination, and - what is the relationship between it, Activities, Locations, and Places?

        -
        -

        A "Destination" is a specific region/city/area of a larger "Place". For instance, - a Place might be Earth where a Destination might be Bellevue, Washington. ( - Please, pick a more interesting destination if you come to visit Earth).

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyDestinationDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activityGraphEntries

        - - -
        -
        -

        If the Destination has default Activity Graphs (i.e. "Map") that should be shown - in the director, this is the list of those Graphs. At most, only one should be - active at any given time for a Destination: these would represent, for example, - different variants on a Map if the Destination is changing on a macro level - based on game state.

        -
        -
        -
        -
        - -

        bubbleSettings

        - - -
        -
        -

        A Destination may have many "Bubbles" zones with human readable properties.

        -
        -

        We don't get as much info as I'd like about them - I'd love to return info like - where on the map they are located - but at least this gives you the name of - those bubbles. bubbleSettings and bubbles both have the identical number of - entries, and you should match up their indexes to provide matching bubble and - bubbleSettings data.

        -

        DEPRECATED - Just use bubbles, it now has this data.

        -
        -
        -
        - -

        bubbles

        - - -
        -
        -

        This provides the unique identifiers for every bubble in the destination (only - guaranteed unique within the destination), and any intrinsic properties of the - bubble.

        -
        -

        bubbleSettings and bubbles both have the identical number of entries, and you - should match up their indexes to provide matching bubble and bubbleSettings data.

        -
        -
        -
        - -

        defaultFreeroamActivityHash

        -
        defaultFreeroamActivityHash: number
        - -
        -
        -

        If this Destination has a default Free-Roam activity, this is the hash for that - Activity. Use it to look up the DestinyActivityDefintion.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        displayProperties

        - - -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        placeHash

        -
        placeHash: number
        - -
        -
        -

        The place that "owns" this Destination. Use this hash to look up the - DestinyPlaceDefinition.

        -
        -

        Mapped to IDestinyPlaceDefinition in the manifest.

        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinydisplaycategorydefinition.html b/docs/interfaces/idestinydisplaycategorydefinition.html deleted file mode 100644 index d5fbd29..0000000 --- a/docs/interfaces/idestinydisplaycategorydefinition.html +++ /dev/null @@ -1,342 +0,0 @@ - - - - - - IDestinyDisplayCategoryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyDisplayCategoryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Display Categories are different from "categories" in that these are - specifically for visual grouping and display of categories in Vendor UI. The " - categories" structure is for validation of the contained items, and can be - categorized entirely separately from "Display Categories", there need be and - often will be no meaningful relationship between the two.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyDisplayCategoryDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        displayCategoryHash

        -
        displayCategoryHash: number
        - -
        -
        - -

        displayInBanner

        -
        displayInBanner: boolean
        - -
        -
        -

        If true, this category should be displayed in the "Banner" section of the vendor' - s UI.

        -
        -
        -
        -
        - -

        displayProperties

        - - -
        -
        - -

        Optional displayStyleHash

        -
        displayStyleHash: number
        - -
        -
        -

        An indicator of how the category will be displayed in the UI. It's up to you to - do something cool or interesting in response to this, or just to treat it as a - normal category.

        -
        -
        -
        -
        - -

        displayStyleIdentifier

        -
        displayStyleIdentifier: string
        - -
        -
        -

        An indicator of how the category will be displayed in the UI. It's up to you to - do something cool or interesting in response to this, or just to treat it as a - normal category.

        -
        -
        -
        -
        - -

        identifier

        -
        identifier: string
        - -
        -
        -

        A string identifier for the display category.

        -
        -
        -
        -
        - -

        Optional progressionHash

        -
        progressionHash: number
        - -
        -
        -

        If it exists, this is the hash identifier of a DestinyProgressionDefinition that - represents the progression to show on this display category.

        -
        -

        Specific categories can now have thier own distinct progression, apparently. So - that's cool.

        -

        Mapped to IDestinyProgressionDefinition in the manifest.

        -
        -
        -
        - -

        sortOrder

        - - -
        -
        -

        If this category sorts items in a nonstandard way, this will be the way we sort.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinydisplaypropertiesdefinition.html b/docs/interfaces/idestinydisplaypropertiesdefinition.html deleted file mode 100644 index d8cd6b3..0000000 --- a/docs/interfaces/idestinydisplaypropertiesdefinition.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - - IDestinyDisplayPropertiesDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyDisplayPropertiesDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Many Destiny*Definition contracts - the "first order" entities of Destiny that - have their own tables in the Manifest Database - also have displayable - information. This is the base class for that display information.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyDisplayPropertiesDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        description

        -
        description: string
        - -
        -
        - -

        hasIcon

        -
        hasIcon: boolean
        - -
        -
        - -

        icon

        -
        icon: string
        - -
        -
        -

        Note that "icon" is sometimes misleading, and should be interpreted in the - context of the entity. For instance, in Destiny 1 the - DestinyRecordBookDefinition's icon was a big picture of a book.

        -
        -

        But usually, it will be a small square image that you can use as... well, an - icon.

        -
        -
        -
        - -

        name

        -
        name: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyentitysearchresult.html b/docs/interfaces/idestinyentitysearchresult.html deleted file mode 100644 index d261ac5..0000000 --- a/docs/interfaces/idestinyentitysearchresult.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - - IDestinyEntitySearchResult | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyEntitySearchResult

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The results of a search for Destiny content. This will be improved on over time, - I've been doing some experimenting to see what might be useful.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyEntitySearchResult -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        results

        - - -
        -
        -

        The items found that are matches/near matches for the searched-for term, sorted - by something vaguely resembling "relevance". Hopefully this will get better in - the future.

        -
        -
        -
        -
        - -

        suggestedWords

        -
        suggestedWords: string[]
        - -
        -
        -

        A list of suggested words that might make for better search results, based on - the text searched for.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyentitysearchresultitem.html b/docs/interfaces/idestinyentitysearchresultitem.html deleted file mode 100644 index 21327af..0000000 --- a/docs/interfaces/idestinyentitysearchresultitem.html +++ /dev/null @@ -1,268 +0,0 @@ - - - - - - IDestinyEntitySearchResultItem | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyEntitySearchResultItem

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        An individual Destiny Entity returned from the entity search.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyEntitySearchResultItem -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        -

        Basic display properties on the entity, so you don't have to look up the - definition to show basic results for the item.

        -
        -
        -
        -
        - -

        entityType

        -
        entityType: string
        - -
        -
        -

        The type of entity, returned as a string matching the DestinyDefinition's - contract class name. You'll have to have your own mapping from class names to - actually looking up those definitions in the manifest databases.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The hash identifier of the entity. You will use this to look up the - DestinyDefinition relevant for the entity found.

        -
        -
        -
        -
        - -

        weight

        -
        weight: number
        - -
        -
        -

        The ranking value for sorting that we calculated using our relevance formula. - This will hopefully get better with time and iteration.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyenvironmentlocationmapping.html b/docs/interfaces/idestinyenvironmentlocationmapping.html deleted file mode 100644 index 12b903c..0000000 --- a/docs/interfaces/idestinyenvironmentlocationmapping.html +++ /dev/null @@ -1,285 +0,0 @@ - - - - - - IDestinyEnvironmentLocationMapping | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyEnvironmentLocationMapping

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyEnvironmentLocationMapping -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activationSource

        -
        activationSource: string
        - -
        -
        -

        A hint that the UI uses to figure out how this location is activated by the - player.

        -
        -
        -
        -
        - -

        Optional activityHash

        -
        activityHash: number
        - -
        -
        -

        If this is populated, this is the activity you have to be playing in order to - see this location appear because of this mapping. (theoretically, a location can - have multiple mappings, and some might require you to be in a specific activity - when others don't)

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        Optional itemHash

        -
        itemHash: number
        - -
        -
        -

        If this is populated, it is the item that you must possess for this location to - be active because of this mapping. (theoretically, a location can have multiple - mappings, and some might require an item while others don't)

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        locationHash

        -
        locationHash: number
        - -
        -
        -

        The location that is revealed on the director by this mapping.

        -
        -

        Mapped to IDestinyLocationDefinition in the manifest.

        -
        -
        -
        - -

        Optional objectiveHash

        -
        objectiveHash: number
        - -
        -
        -

        If this is populated, this is an objective related to the location.

        -
        -

        Mapped to IDestinyObjectiveDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyequipitemresult.html b/docs/interfaces/idestinyequipitemresult.html deleted file mode 100644 index e9ac71b..0000000 --- a/docs/interfaces/idestinyequipitemresult.html +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - IDestinyEquipItemResult | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyEquipItemResult

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The results of an Equipping operation performed through the Destiny API.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyEquipItemResult -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        equipStatus

        -
        equipStatus: PlatformErrorCodes
        - -
        -
        -

        A PlatformErrorCodes enum indicating whether it succeeded, and if it failed why.

        -
        -
        -
        -
        - -

        itemInstanceId

        -
        itemInstanceId: string
        - -
        -
        -

        The instance ID of the item in question (all items that can be equipped must, - but definition, be Instanced and thus have an Instance ID that you can use to - refer to them)

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyequipitemresults.html b/docs/interfaces/idestinyequipitemresults.html deleted file mode 100644 index 157a4e2..0000000 --- a/docs/interfaces/idestinyequipitemresults.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - - IDestinyEquipItemResults | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyEquipItemResults

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The results of a bulk Equipping operation performed through the Destiny API.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyEquipItemResults -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        equipResults

        -
        equipResults: IDestinyEquipItemResult[]
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyequipmentslotdefinition.html b/docs/interfaces/idestinyequipmentslotdefinition.html deleted file mode 100644 index d2e02dc..0000000 --- a/docs/interfaces/idestinyequipmentslotdefinition.html +++ /dev/null @@ -1,354 +0,0 @@ - - - - - - IDestinyEquipmentSlotDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyEquipmentSlotDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Characters can not only have Inventory buckets (containers of items that are - generally matched by their type or functionality), they can also have Equipment - Slots.

        -
        -

        The Equipment Slot is an indicator that the related bucket can have instanced - items equipped on the character. For instance, the Primary Weapon bucket has an - Equipment Slot that determines whether you can equip primary weapons, and holds - the association between its slot and the inventory bucket from which it can have - items equipped.

        -

        An Equipment Slot must have a related Inventory Bucket, but not all inventory - buckets must have Equipment Slots.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyEquipmentSlotDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        applyCustomArtDyes

        -
        applyCustomArtDyes: boolean
        - -
        -
        -

        If True, equipped items should have their custom art dyes applied when rendering - the item. Otherwise, custom art dyes on an item should be ignored if the item is - equipped in this slot.

        -
        -
        -
        -
        - -

        artDyeChannels

        -
        artDyeChannels: IDestinyArtDyeReference[]
        - -
        -
        -

        The Art Dye Channels that apply to this equipment slot.

        -
        -
        -
        -
        - -

        bucketTypeHash

        -
        bucketTypeHash: number
        - -
        -
        -

        The inventory bucket that owns this equipment slot.

        -
        -

        Mapped to IDestinyInventoryBucketDefinition in the manifest.

        -
        -
        -
        - -

        displayProperties

        - - -
        -
        - -

        equipmentCategoryHash

        -
        equipmentCategoryHash: number
        - -
        -
        -

        These technically point to "Equipment Category Definitions". But don't get - excited. There's nothing of significant value in those definitions, so I didn't - bother to expose them. You can use the hash here to group equipment slots by - common functionality, which serves the same purpose as if we had the Equipment - Category definitions exposed.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyequippingblockdefinition.html b/docs/interfaces/idestinyequippingblockdefinition.html deleted file mode 100644 index ac27cd2..0000000 --- a/docs/interfaces/idestinyequippingblockdefinition.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - - IDestinyEquippingBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyEquippingBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Items that can be equipped define this block. It contains information we need to - understand how and when the item can be equipped.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyEquippingBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        ammoType

        - - -
        -
        -

        Ammo type used by a weapon is no longer determined by the bucket in which it is - contained. If the item has an ammo type - i.e. if it is a weapon - this will be - the type of ammunition expected.

        -
        -
        -
        -
        - -

        attributes

        - - -
        -
        -

        These are custom attributes on the equippability of the item.

        -
        -

        For now, this can only be "equip on acquire", which would mean that the item - will be automatically equipped as soon as you pick it up.

        -
        -
        -
        - -

        displayStrings

        -
        displayStrings: string[]
        - -
        -
        -

        These are strings that represent the possible Game/Account/Character state - failure conditions that can occur when trying to equip the item. They match up - one-to-one with requiredUnlockExpressions.

        -
        -
        -
        -
        - -

        equipmentSlotTypeHash

        -
        equipmentSlotTypeHash: number
        - -
        -
        -

        An equipped item must be equipped in an Equipment Slot. This is the hash - identifier of the DestinyEquipmentSlotDefinition into which it must be equipped.

        -
        -

        Mapped to IDestinyEquipmentSlotDefinition in the manifest.

        -
        -
        -
        - -

        Optional gearsetItemHash

        -
        gearsetItemHash: number
        - -
        -
        -

        If the item is part of a gearset, this is a reference to that gearset item.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        uniqueLabel

        -
        uniqueLabel: string
        - -
        -
        -

        If defined, this is the label used to check if the item has other items of - matching types already equipped.

        -
        -

        For instance, when you aren't allowed to equip more than one Exotic Weapon, that' - s because all exotic weapons have identical uniqueLabels and the game checks the - to-be-equipped item's uniqueLabel vs. all other already equipped items (other - than the item in the slot that's about to be occupied).

        -
        -
        -
        - -

        uniqueLabelHash

        -
        uniqueLabelHash: number
        - -
        -
        -

        The hash of that unique label. Does not point to a specific definition.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyerrorprofile.html b/docs/interfaces/idestinyerrorprofile.html deleted file mode 100644 index 515cec6..0000000 --- a/docs/interfaces/idestinyerrorprofile.html +++ /dev/null @@ -1,231 +0,0 @@ - - - - - - IDestinyErrorProfile | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyErrorProfile

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If a Destiny Profile can't be returned, but we're pretty certain it's a valid - Destiny account, this will contain as much info as we can get about the profile - for your use.

        -
        -

        Assume that the most you'll get is the Error Code, the Membership Type and the - Membership ID.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyErrorProfile -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        errorCode

        - - -
        -
        -

        The error that we encountered. You should be able to look up localized text to - show to the user for these failures.

        -
        -
        -
        -
        - -

        infoCard

        -
        infoCard: IUserInfoCard
        - -
        -
        -

        Basic info about the account that failed. Don't expect anything other than - membership ID, Membership Type, and displayName to be populated.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyfactiondefinition.html b/docs/interfaces/idestinyfactiondefinition.html deleted file mode 100644 index 509bb3c..0000000 --- a/docs/interfaces/idestinyfactiondefinition.html +++ /dev/null @@ -1,377 +0,0 @@ - - - - - - IDestinyFactionDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyFactionDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        These definitions represent Factions in the game. Factions have ended up - unilaterally being related to Vendors that represent them, but that need not - necessarily be the case.

        -
        -

        A Faction is really just an entity that has a related progression for which a - character can gain experience. In Destiny 1, Dead Orbit was an example of a - Faction: there happens to be a Vendor that represents Dead Orbit (and indeed, - DestinyVendorDefinition.factionHash defines to this relationship), but Dead - Orbit could theoretically exist without the Vendor that provides rewards.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyFactionDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        progressionHash

        -
        progressionHash: number
        - -
        -
        -

        The hash identifier for the DestinyProgressionDefinition that indicates the - character's relationship with this faction in terms of experience and levels.

        -
        -

        Mapped to IDestinyProgressionDefinition in the manifest.

        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        rewardItemHash

        -
        rewardItemHash: number
        - -
        -
        -

        The faction reward item hash, usually an engram.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        rewardVendorHash

        -
        rewardVendorHash: number
        - -
        -
        -

        The faction reward vendor hash, used for faction engram previews.

        -
        -

        Mapped to IDestinyVendorDefinition in the manifest.

        -
        -
        -
        - -

        tokenValues

        -
        tokenValues: object
        - -
        -
        -

        The faction token item hashes, and their respective progression values.

        -
        -
        -
        -

        Type declaration

        -
          -
        • -
          [key: number]: number
          -
        • -
        -
        -
        -
        - -

        vendors

        - - -
        -
        -

        List of vendors that are associated with this faction. The last vendor that - passes the unlock flag checks is the one that should be shown.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyfactionprogression.html b/docs/interfaces/idestinyfactionprogression.html deleted file mode 100644 index df9b3fb..0000000 --- a/docs/interfaces/idestinyfactionprogression.html +++ /dev/null @@ -1,450 +0,0 @@ - - - - - - IDestinyFactionProgression | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyFactionProgression

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Mostly for historical purposes, we segregate Faction progressions from other - progressions. This is just a DestinyProgression with a shortcut for finding the - DestinyFactionDefinition of the faction related to the progression.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyFactionProgression -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        currentProgress

        -
        currentProgress: number
        - -
        -
        -

        This is the total amount of progress obtained overall for this progression (for - instance, the total amount of Character Level experience earned)

        -
        -
        -
        -
        - -

        dailyLimit

        -
        dailyLimit: number
        - -
        -
        -

        If this progression has a daily limit, this is that limit.

        -
        -
        -
        -
        - -

        dailyProgress

        -
        dailyProgress: number
        - -
        -
        -

        The amount of progress earned today for this progression.

        -
        -
        -
        -
        - -

        factionHash

        -
        factionHash: number
        - -
        -
        -

        The hash identifier of the Faction related to this progression. Use it to look - up the DestinyFactionDefinition for more rendering info.

        -
        -

        Mapped to IDestinyFactionDefinition in the manifest.

        -
        -
        -
        - -

        factionVendorIndex

        -
        factionVendorIndex: number
        - -
        -
        -

        The index of the Faction vendor that is currently available. Will be set to -1 - if no vendors are available.

        -
        -
        -
        -
        - -

        level

        -
        level: number
        - -
        -
        -

        This is the level of the progression (for instance, the Character Level).

        -
        -
        -
        -
        - -

        levelCap

        -
        levelCap: number
        - -
        -
        -

        This is the maximum possible level you can achieve for this progression (for - example, the maximum character level obtainable)

        -
        -
        -
        -
        - -

        nextLevelAt

        -
        nextLevelAt: number
        - -
        -
        -

        The total amount of progression (i.e. "Experience") needed in order to reach the - next level.

        -
        -
        -
        -
        - -

        progressToNextLevel

        -
        progressToNextLevel: number
        - -
        -
        -

        The amount of progression (i.e. "Experience") needed to reach the next level of - this Progression. Jeez, progression is such an overloaded word.

        -
        -
        -
        -
        - -

        progressionHash

        -
        progressionHash: number
        - -
        -
        -

        The hash identifier of the Progression in question. Use it to look up the - DestinyProgressionDefinition in static data.

        -
        -

        Mapped to IDestinyProgressionDefinition in the manifest.

        -
        -
        -
        - -

        stepIndex

        -
        stepIndex: number
        - -
        -
        -

        Progressions define their levels in "steps". Since the last step may be - repeatable, the user may be at a higher level than the actual Step achieved in - the progression. Not necessarily useful, but potentially interesting for those - cruising the API. Relate this to the "steps" property of the DestinyProgression - to see which step the user is on, if you care about that. (Note that this is - Content Version dependent since it refers to indexes.)

        -
        -
        -
        -
        - -

        weeklyLimit

        -
        weeklyLimit: number
        - -
        -
        -

        If this progression has a weekly limit, this is that limit.

        -
        -
        -
        -
        - -

        weeklyProgress

        -
        weeklyProgress: number
        - -
        -
        -

        The amount of progress earned toward this progression in the current week.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyfactionvendordefinition.html b/docs/interfaces/idestinyfactionvendordefinition.html deleted file mode 100644 index b007059..0000000 --- a/docs/interfaces/idestinyfactionvendordefinition.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - IDestinyFactionVendorDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyFactionVendorDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        These definitions represent faction vendors at different points in the game.

        -
        -

        A single faction may contain multiple vendors, or the same vendor available at - two different locations.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyFactionVendorDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        backgroundImagePath

        -
        backgroundImagePath: string
        - -
        -
        -

        The relative path to the background image representing this Vendor at this - location, for use in a banner.

        -
        -
        -
        -
        - -

        destinationHash

        -
        destinationHash: number
        - -
        -
        -

        The hash identifier for a Destination at which this vendor may be located. Each - destination where a Vendor may exist will only ever have a single entry.

        -
        -

        Mapped to IDestinyDestinationDefinition in the manifest.

        -
        -
        -
        - -

        vendorHash

        -
        vendorHash: number
        - -
        -
        -

        The faction vendor hash.

        -
        -

        Mapped to IDestinyVendorDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinygearartarrangementreference.html b/docs/interfaces/idestinygearartarrangementreference.html deleted file mode 100644 index 655bb84..0000000 --- a/docs/interfaces/idestinygearartarrangementreference.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IDestinyGearArtArrangementReference | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyGearArtArrangementReference

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyGearArtArrangementReference -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        artArrangementHash

        -
        artArrangementHash: number
        - -
        -
        - -

        classHash

        -
        classHash: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinygenderdefinition.html b/docs/interfaces/idestinygenderdefinition.html deleted file mode 100644 index 301930b..0000000 --- a/docs/interfaces/idestinygenderdefinition.html +++ /dev/null @@ -1,284 +0,0 @@ - - - - - - IDestinyGenderDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyGenderDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Gender is a social construct, and as such we have definitions for Genders. Right - now there happens to only be two, but we'll see what the future holds.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyGenderDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        - -

        genderType

        -
        genderType: DestinyGender
        - -
        -
        -

        This is a quick reference enumeration for all of the currently defined Genders. - We use the enumeration for quicker lookups in related data, like - DestinyClassDefinition.genderedClassNames.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyhistoricalstatsaccountresult.html b/docs/interfaces/idestinyhistoricalstatsaccountresult.html deleted file mode 100644 index abca798..0000000 --- a/docs/interfaces/idestinyhistoricalstatsaccountresult.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IDestinyHistoricalStatsAccountResult | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyHistoricalStatsAccountResult

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyHistoricalStatsAccountResult -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        characters

        - - -
        -
        - -

        mergedAllCharacters

        - - -
        -
        - -

        mergedDeletedCharacters

        -
        mergedDeletedCharacters: IDestinyHistoricalStatsWithMerged
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyhistoricalstatsactivity.html b/docs/interfaces/idestinyhistoricalstatsactivity.html deleted file mode 100644 index 4756f8f..0000000 --- a/docs/interfaces/idestinyhistoricalstatsactivity.html +++ /dev/null @@ -1,309 +0,0 @@ - - - - - - IDestinyHistoricalStatsActivity | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyHistoricalStatsActivity

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Summary information about the activity that was played.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyHistoricalStatsActivity -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        directorActivityHash

        -
        directorActivityHash: number
        - -
        -
        -

        The unique hash identifier of the DestinyActivityDefinition that was played.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        instanceId

        -
        instanceId: string
        - -
        -
        -

        The unique identifier for this specific match that was played.

        -
        -

        This value can be used to get additional data about this activity such as who - else was playing via the GetPostGameCarnageReport endpoint.

        -
        -
        -
        - -

        isPrivate

        -
        isPrivate: boolean
        - -
        -
        -

        Whether or not the match was a private match. There's no private matches in - Destiny 2... yet... DUN DUN DUNNNN

        -
        -
        -
        -
        - -

        mode

        - - -
        -
        -

        Indicates the most specific game mode of the activity that we could find.

        -
        -
        -
        -
        - -

        modes

        - - -
        -
        -

        The list of all Activity Modes to which this activity applies, including - aggregates. This will let you see, for example, whether the activity was both - Clash and part of the Trials of the Nine event.

        -
        -
        -
        -
        - -

        referenceId

        -
        referenceId: number
        - -
        -
        -

        The unique hash identifier of the DestinyActivityDefinition that was played. If - I had this to do over, it'd be named activityHash. Too late now.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyhistoricalstatsbyperiod.html b/docs/interfaces/idestinyhistoricalstatsbyperiod.html deleted file mode 100644 index c9b1ff9..0000000 --- a/docs/interfaces/idestinyhistoricalstatsbyperiod.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - IDestinyHistoricalStatsByPeriod | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyHistoricalStatsByPeriod

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyHistoricalStatsByPeriod -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        allTime

        -
        allTime: object
        - -
        -

        Type declaration

        - -
        -
        -
        - -

        allTimeTier1

        -
        allTimeTier1: object
        - -
        -

        Type declaration

        - -
        -
        -
        - -

        allTimeTier2

        -
        allTimeTier2: object
        - -
        -

        Type declaration

        - -
        -
        -
        - -

        allTimeTier3

        -
        allTimeTier3: object
        - -
        -

        Type declaration

        - -
        -
        -
        - -

        daily

        - - -
        -
        - -

        monthly

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyhistoricalstatsdefinition.html b/docs/interfaces/idestinyhistoricalstatsdefinition.html deleted file mode 100644 index 6ac0ff7..0000000 --- a/docs/interfaces/idestinyhistoricalstatsdefinition.html +++ /dev/null @@ -1,446 +0,0 @@ - - - - - - IDestinyHistoricalStatsDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyHistoricalStatsDefinition

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyHistoricalStatsDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        category

        - - -
        -
        -

        Category for the stat.

        -
        -
        -
        -
        - -

        group

        - - -
        -
        -

        Statistic group

        -
        -
        -
        -
        - -

        iconImage

        -
        iconImage: string
        - -
        -
        -

        Optional URI to an icon for the statistic

        -
        -
        -
        -
        - -

        Optional medalTierHash

        -
        medalTierHash: number
        - -
        -
        -

        The tier associated with this medal - be it implicitly or explicitly.

        -
        -
        -
        -
        - -

        Optional mergeMethod

        -
        mergeMethod: number
        - -
        -
        -

        Optional icon for the statistic

        -
        -
        -
        -
        - -

        modes

        - - -
        -
        -

        Game modes where this statistic can be reported.

        -
        -
        -
        -
        - -

        periodTypes

        -
        periodTypes: PeriodType[]
        - -
        -
        -

        Time periods the statistic covers

        -
        -
        -
        -
        - -

        statDescription

        -
        statDescription: string
        - -
        -
        -

        Description of a stat if applicable.

        -
        -
        -
        -
        - -

        statId

        -
        statId: string
        - -
        -
        -

        Unique programmer friendly ID for this stat

        -
        -
        -
        -
        - -

        statName

        -
        statName: string
        - -
        -
        -

        Display name

        -
        -
        -
        -
        - -

        statNameAbbr

        -
        statNameAbbr: string
        - -
        -
        -

        Display name abbreviated

        -
        -
        -
        -
        - -

        unitLabel

        -
        unitLabel: string
        - -
        -
        -

        Localized Unit Name for the stat.

        -
        -
        -
        -
        - -

        unitType

        -
        unitType: UnitType
        - -
        -
        -

        Unit, if any, for the statistic

        -
        -
        -
        -
        - -

        weight

        -
        weight: number
        - -
        -
        -

        Weight assigned to this stat indicating its relative impressiveness.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyhistoricalstatspercharacter.html b/docs/interfaces/idestinyhistoricalstatspercharacter.html deleted file mode 100644 index 4815e2a..0000000 --- a/docs/interfaces/idestinyhistoricalstatspercharacter.html +++ /dev/null @@ -1,244 +0,0 @@ - - - - - - IDestinyHistoricalStatsPerCharacter | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyHistoricalStatsPerCharacter

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyHistoricalStatsPerCharacter -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        characterId

        -
        characterId: string
        - -
        -
        - -

        deleted

        -
        deleted: boolean
        - -
        -
        - -

        merged

        - - -
        -
        - -

        results

        -
        results: object
        - -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyhistoricalstatsperiodgroup.html b/docs/interfaces/idestinyhistoricalstatsperiodgroup.html deleted file mode 100644 index cffc230..0000000 --- a/docs/interfaces/idestinyhistoricalstatsperiodgroup.html +++ /dev/null @@ -1,247 +0,0 @@ - - - - - - IDestinyHistoricalStatsPeriodGroup | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyHistoricalStatsPeriodGroup

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyHistoricalStatsPeriodGroup -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activityDetails

        - - -
        -
        -

        If the period group is for a specific activity, this property will be set.

        -
        -
        -
        -
        - -

        period

        -
        period: string
        - -
        -
        -

        Period for the group. If the stat periodType is day, then this will have a - specific day. If the type is monthly, then this value will be the first day of - the applicable month. This value is not set when the periodType is 'all time'.

        -
        -
        -
        -
        - -

        values

        -
        values: object
        - -
        -
        -

        Collection of stats for the period.

        -
        -
        -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyhistoricalstatsvalue.html b/docs/interfaces/idestinyhistoricalstatsvalue.html deleted file mode 100644 index 8c99ba7..0000000 --- a/docs/interfaces/idestinyhistoricalstatsvalue.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - - IDestinyHistoricalStatsValue | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyHistoricalStatsValue

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyHistoricalStatsValue -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        Optional activityId

        -
        activityId: string
        - -
        -
        -

        When a stat represents the best, most, longest, fastest or some other personal - best, the actual activity ID where that personal best was established is - available on this property.

        -
        -
        -
        -
        - -

        basic

        - - -
        -
        -

        Basic stat value.

        -
        -
        -
        -
        - -

        pga

        - - -
        -
        -

        Per game average for the statistic, if applicable

        -
        -
        -
        -
        - -

        statId

        -
        statId: string
        - -
        -
        -

        Unique ID for this stat

        -
        -
        -
        -
        - -

        weighted

        - - -
        -
        -

        Weighted value of the stat if a weight greater than 1 has been assigned.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyhistoricalstatsvaluepair.html b/docs/interfaces/idestinyhistoricalstatsvaluepair.html deleted file mode 100644 index 3907885..0000000 --- a/docs/interfaces/idestinyhistoricalstatsvaluepair.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - - IDestinyHistoricalStatsValuePair | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyHistoricalStatsValuePair

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyHistoricalStatsValuePair -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayValue

        -
        displayValue: string
        - -
        -
        -

        Localized formated version of the value.

        -
        -
        -
        -
        - -

        value

        -
        value: number
        - -
        -
        -

        Raw value of the statistic

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyhistoricalstatswithmerged.html b/docs/interfaces/idestinyhistoricalstatswithmerged.html deleted file mode 100644 index 0424ab8..0000000 --- a/docs/interfaces/idestinyhistoricalstatswithmerged.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - - IDestinyHistoricalStatsWithMerged | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyHistoricalStatsWithMerged

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyHistoricalStatsWithMerged -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        merged

        - - -
        -
        - -

        results

        -
        results: object
        - -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyhistoricalweaponstats.html b/docs/interfaces/idestinyhistoricalweaponstats.html deleted file mode 100644 index ac1fbd0..0000000 --- a/docs/interfaces/idestinyhistoricalweaponstats.html +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - IDestinyHistoricalWeaponStats | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyHistoricalWeaponStats

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyHistoricalWeaponStats -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        referenceId

        -
        referenceId: number
        - -
        -
        -

        The hash ID of the item definition that describes the weapon.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        values

        -
        values: object
        - -
        -
        -

        Collection of stats for the period.

        -
        -
        -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyhistoricalweaponstatsdata.html b/docs/interfaces/idestinyhistoricalweaponstatsdata.html deleted file mode 100644 index 3c8de25..0000000 --- a/docs/interfaces/idestinyhistoricalweaponstatsdata.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - IDestinyHistoricalWeaponStatsData | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyHistoricalWeaponStatsData

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyHistoricalWeaponStatsData -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        weapons

        - - -
        -
        -

        List of weapons and their perspective values.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyinsertplugactiondefinition.html b/docs/interfaces/idestinyinsertplugactiondefinition.html deleted file mode 100644 index 7058609..0000000 --- a/docs/interfaces/idestinyinsertplugactiondefinition.html +++ /dev/null @@ -1,230 +0,0 @@ - - - - - - IDestinyInsertPlugActionDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyInsertPlugActionDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Data related to what happens while a plug is being inserted, mostly for UI - purposes.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyInsertPlugActionDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        actionExecuteSeconds

        -
        actionExecuteSeconds: number
        - -
        -
        -

        How long it takes for the Plugging of the item to be completed once it is - initiated, if you care.

        -
        -
        -
        -
        - -

        actionType

        - - -
        -
        -

        The type of action being performed when you act on this Socket Type. The most - common value is "insert plug", but there are others as well (for instance, a " - Masterwork" socket may allow for Re-initialization, and an Infusion socket - allows for items to be consumed to upgrade the item)

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyinsertplugsactionrequest.html b/docs/interfaces/idestinyinsertplugsactionrequest.html deleted file mode 100644 index d10528b..0000000 --- a/docs/interfaces/idestinyinsertplugsactionrequest.html +++ /dev/null @@ -1,266 +0,0 @@ - - - - - - IDestinyInsertPlugsActionRequest | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyInsertPlugsActionRequest

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyInsertPlugsActionRequest -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        actionToken

        -
        actionToken: string
        - -
        -
        -

        Action token provided by the AwaGetActionToken API call.

        -
        -
        -
        -
        - -

        characterId

        -
        characterId: string
        - -
        -
        - -

        itemInstanceId

        -
        itemInstanceId: string
        - -
        -
        -

        The instance ID of the item having a plug inserted. Only instanced items can - have sockets.

        -
        -
        -
        -
        - -

        membershipType

        -
        membershipType: BungieMembershipType
        - -
        -
        - -

        plug

        - - -
        -
        -

        The plugs being inserted.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyinsertplugsrequestentry.html b/docs/interfaces/idestinyinsertplugsrequestentry.html deleted file mode 100644 index ab92764..0000000 --- a/docs/interfaces/idestinyinsertplugsrequestentry.html +++ /dev/null @@ -1,255 +0,0 @@ - - - - - - IDestinyInsertPlugsRequestEntry | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyInsertPlugsRequestEntry

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents all of the data related to a single plug to be inserted.

        -
        -

        Note that, while you can point to a socket that represents infusion, you will - receive an error if you attempt to do so. Come on guys, let's play nice.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyInsertPlugsRequestEntry -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        plugItemHash

        -
        plugItemHash: number
        - -
        -
        -

        Plugs are never instanced (except in infusion). So with the hash alone, we - should be able to: 1) Infer whether the player actually needs to have the item, - or if it's a reusable plug 2) Perform any operation needed to use the Plug, - including removing the plug item and running reward sheets.

        -
        -
        -
        -
        - -

        socketArrayType

        -
        socketArrayType: DestinySocketArrayType
        - -
        -
        -

        This property, combined with the socketIndex, tells us which socket we are - referring to (since operations can be performed on both Intrinsic and "default" - sockets, and they occupy different arrays in the Inventory Item Definition). I - know, I know. Don't give me that look.

        -
        -
        -
        -
        - -

        socketIndex

        -
        socketIndex: number
        - -
        -
        -

        The index into the socket array, which identifies the specific socket being - operated on. We also need to know the socketArrayType in order to uniquely - identify the socket.

        -
        -

        Don't point to or try to insert a plug into an infusion socket. It won't work.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyinventorybucketdefinition.html b/docs/interfaces/idestinyinventorybucketdefinition.html deleted file mode 100644 index 66318cd..0000000 --- a/docs/interfaces/idestinyinventorybucketdefinition.html +++ /dev/null @@ -1,449 +0,0 @@ - - - - - - IDestinyInventoryBucketDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyInventoryBucketDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        An Inventory (be it Character or Profile level) is comprised of many Buckets. An - example of a bucket is "Primary Weapons", where all of the primary weapons on a - character are gathered together into a single visual element in the UI: a subset - of the inventory that has a limited number of slots, and in this case also has - an associated Equipment Slot for equipping an item in the bucket.

        -
        -

        Item definitions declare what their "default" bucket is ( - DestinyInventoryItemDefinition.inventory.bucketTypeHash), and Item instances - will tell you which bucket they are currently residing in (DestinyItemComponent. - bucketHash). You can use this information along with the - DestinyInventoryBucketDefinition to show these items grouped by bucket.

        -

        You cannot transfer an item to a bucket that is not its Default without going - through a Vendor's "accepted items" (DestinyVendorDefinition.acceptedItems). - This is how transfer functionality like the Vault is implemented, as a feature - of a Vendor. See the vendor's acceptedItems property for more details.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyInventoryBucketDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        bucketOrder

        -
        bucketOrder: number
        - -
        -
        -

        Use this property to provide a quick-and-dirty recommended ordering for buckets - in the UI. Most UIs will likely want to forsake this for something more custom - and manual.

        -
        -
        -
        -
        - -

        category

        -
        category: BucketCategory
        - -
        -
        -

        An enum value for what items can be found in the bucket. See the BucketCategory - enum for more details.

        -
        -
        -
        -
        - -

        displayProperties

        - - -
        -
        - -

        enabled

        -
        enabled: boolean
        - -
        -
        -

        If True, this bucket is enabled. Disabled buckets may include buckets that were - included for test purposes, or that were going to be used but then were - abandoned but never removed from content cough.

        -
        -
        -
        -
        - -

        fifo

        -
        fifo: boolean
        - -
        -
        -

        if a FIFO bucket fills up, it will delete the oldest item from said bucket when - a new item tries to be added to it. If this is FALSE, the bucket will not allow - new items to be placed in it until room is made by the user manually deleting - items from it. You can see an example of this with the Postmaster's bucket.

        -
        -
        -
        -
        - -

        hasTransferDestination

        -
        hasTransferDestination: boolean
        - -
        -
        -

        If TRUE, there is at least one Vendor that can transfer items to/from this - bucket. See the DestinyVendorDefinition's acceptedItems property for more - information on how transferring works.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        itemCount

        -
        itemCount: number
        - -
        -
        -

        The maximum # of item "slots" in a bucket. A slot is a given combination of item

        -
          -
        • quantity.
        • -
        -
        -

        For instance, a Weapon will always take up a single slot, and always have a - quantity of 1. But a material could take up only a single slot with hundreds of - quantity.

        -
        -
        -
        - -

        location

        -
        location: ItemLocation
        - -
        -
        -

        Sometimes, inventory buckets represent conceptual "locations" in the game that - might not be expected. This value indicates the conceptual location of the - bucket, regardless of where it is actually contained on the character/account.

        -
        -

        See ItemLocation for details.

        -

        Note that location includes the Vault and the Postmaster (both of whom being - just inventory buckets with additional actions that can be performed on them - through a Vendor)

        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        scope

        - - -
        -
        -

        Where the bucket is found. 0 = Character, 1 = Account

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyinventorycomponent.html b/docs/interfaces/idestinyinventorycomponent.html deleted file mode 100644 index 864e0e9..0000000 --- a/docs/interfaces/idestinyinventorycomponent.html +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - IDestinyInventoryComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyInventoryComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A list of minimal information for items in an inventory: be it a character's - inventory, or a Profile's inventory. (Note that the Vault is a collection of - inventory buckets in the Profile's inventory)

        -
        -

        Inventory Items returned here are in a flat list, but importantly they have a - bucketHash property that indicates the specific inventory bucket that is holding - them. These buckets constitute things like the separate sections of the Vault, - the user's inventory slots, etc. See DestinyInventoryBucketDefinition for more - info.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyInventoryComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        items

        - - -
        -
        -

        The items in this inventory. If you care to bucket them, use the item's - bucketHash property to group them.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyinventoryitemdefinition.html b/docs/interfaces/idestinyinventoryitemdefinition.html deleted file mode 100644 index 04d7f0a..0000000 --- a/docs/interfaces/idestinyinventoryitemdefinition.html +++ /dev/null @@ -1,1325 +0,0 @@ - - - - - - IDestinyInventoryItemDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyInventoryItemDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        So much of what you see in Destiny is actually an Item used in a new and - creative way. This is the definition for Items in Destiny, which started off as - just entities that could exist in your Inventory but ended up being the backing - data for so much more: quests, reward previews, slots, and subclasses.

        -
        -

        In practice, you will want to associate this data with "live" item data from a - Bungie.Net Platform call: these definitions describe the item in generic, non- - instanced terms: but an actual instance of an item can vary widely from these - generic definitions.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyInventoryItemDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        action

        - - -
        -
        -

        If the item can be "used", this block will be non-null, and will have data - related to the action performed when using the item. (Guess what? 99% of the - time, this action is "dismantle". Shocker)

        -
        -
        -
        -
        - -

        allowActions

        -
        allowActions: boolean
        - -
        -
        -

        BNet may forbid the execution of actions on this item via the API. If that is - occurring, allowActions will be set to false.

        -
        -
        -
        -
        - -

        animations

        - - -
        -
        -

        If any animations were extracted from game content for this item, these will be - the definitions of those animations.

        -
        -
        -
        -
        - -

        backgroundColor

        -
        backgroundColor: IDestinyColor
        - -
        -
        -

        Sometimes, an item will have a background color. Most notably this occurs with - Emblems, who use the Background Color for small character nameplates such as the - "friends" view you see in-game. There are almost certainly other items that have - background color as well, though I have not bothered to investigate what items - have it nor what purposes they serve: use it as you will.

        -
        -
        -
        -
        - -

        classType

        -
        classType: DestinyClass
        - -
        -
        -

        We run a similarly weak-sauce algorithm to try and determine whether an item is - restricted to a specific class. If we find it to be restricted in such a way, we - set this classType property to match the class' enumeration value so that users - can easily identify class restricted items.

        -
        -

        If you see a mis-classed item, please inform the developers in the Bungie API - forum.

        -
        -
        -
        - -

        Optional collectibleHash

        -
        collectibleHash: number
        - -
        -
        -

        If this item has a collectible related to it, this is the hash identifier of - that collectible entry.

        -
        -

        Mapped to IDestinyCollectibleDefinition in the manifest.

        -
        -
        -
        - -

        damageTypeHashes

        -
        damageTypeHashes: number[]
        - -
        -
        -

        Theoretically, an item can have many possible damage types. In practice, this - is not true, but just in case weapons start being made that have multiple (for - instance, an item where a socket has reusable plugs for every possible damage - type that you can choose from freely), this field will return all of the - possible damage types that are available to the weapon by default.

        -
        -

        Mapped to IDestinyDamageTypeDefinition in the manifest.

        -
        -
        -
        - -

        damageTypes

        -
        damageTypes: DamageType[]
        - -
        -
        -

        This is the list of all damage types that we know ahead of time the item can - take on. Unfortunately, this does not preclude the possibility of something - funky happening to give the item a damage type that cannot be predicted - beforehand: for example, if some designer decides to create arbitrary non- - reusable plugs that cause damage type to change.

        -
        -

        This damage type prediction will only use the following to determine potential - damage types:

        -
          -
        • Intrinsic perks

          -
        • -
        • Talent Node perks

          -
        • -
        • Known, reusable plugs for sockets

          -
        • -
        -
        -
        -
        - -

        defaultDamageType

        -
        defaultDamageType: DamageType
        - -
        -
        -

        If the item has a damage type that could be considered to be default, it will be - populated here.

        -
        -

        For various upsetting reasons, it's surprisingly cumbersome to figure this out. - I hope you're happy.

        -
        -
        -
        - -

        Optional defaultDamageTypeHash

        -
        defaultDamageTypeHash: number
        - -
        -
        -

        Similar to defaultDamageType, but represented as the hash identifier for a - DestinyDamageTypeDefinition.

        -
        -

        I will likely regret leaving in the enumeration versions of these properties, - but for now they're very convenient.

        -

        Mapped to IDestinyDamageTypeDefinition in the manifest.

        -
        -
        -
        - -

        displayProperties

        - - -
        -
        - -

        displaySource

        -
        displaySource: string
        - -
        -
        -

        In theory, it is a localized string telling you about how you can find the item. - I really wish this was more consistent. Many times, it has nothing. Sometimes, - it's instead a more narrative-forward description of the item. Which is cool, - and I wish all properties had that data, but it should really be its own - property.

        -
        -
        -
        -
        - -

        doesPostmasterPullHaveSideEffects

        -
        doesPostmasterPullHaveSideEffects: boolean
        - -
        -
        -

        The boolean will indicate to us (and you!) whether something could happen when - you transfer this item from the Postmaster that might be considered a " - destructive" action.

        -
        -

        It is not feasible currently to tell you (or ourelves!) in a consistent way - whether this will actually cause a destructive action, so we are playing it - safe: if it has the potential to do so, we will not allow it to be transferred - from the Postmaster by default. You will need to check for this flag before - transferring an item from the Postmaster, or else you'll end up receiving an - error.

        -
        -
        -
        - -

        Optional emblemObjectiveHash

        -
        emblemObjectiveHash: number
        - -
        -
        -

        If the item is an emblem that has a special Objective attached to it - for - instance, if the emblem tracks PVP Kills, or what-have-you. This is a bit - different from, for example, the Vanguard Kill Tracker mod, which pipes data - into the "art channel". When I get some time, I would like to standardize these - so you can get at the values they expose without having to care about what they' - re being used for and how they are wired up, but for now here's the raw data.

        -
        -
        -
        -
        - -

        equippable

        -
        equippable: boolean
        - -
        -
        -

        If true, then you will be allowed to equip the item if you pass its other - requirements.

        -
        -

        This being false means that you cannot equip the item under any circumstances.

        -
        -
        -
        - -

        equippingBlock

        - - -
        -
        -

        If this item can be equipped, this block will be non-null and will be populated - with the conditions under which it can be equipped.

        -
        -
        -
        -
        - -

        gearset

        - - -
        -
        -

        If this item has related items in a "Gear Set", this will be non-null and the - relationships defined herein.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        inventory

        - - -
        -
        -

        If this item can exist in an inventory, this block will be non-null. In practice, - every item that currently exists has one of these blocks. But note that it is - not necessarily guaranteed.

        -
        -
        -
        -
        - -

        investmentStats

        - - -
        -
        -

        If the item has stats, this block will be defined. It has the "raw" investment - stats for the item. These investment stats don't take into account the ways that - the items can spawn, nor do they take into account any Stat Group - transformations. I have retained them for debugging purposes, but I do not know - how useful people will find them.

        -
        -
        -
        -
        - -

        itemCategoryHashes

        -
        itemCategoryHashes: number[]
        - -
        -
        -

        BNet attempts to make a more formal definition of item "Categories", as defined - by DestinyItemCategoryDefinition. This is a list of all Categories that we were - able to algorithmically determine that this item is a member of. (for instance, - that it's a "Weapon", that it's an "Auto Rifle", etc...)

        -
        -

        The algorithm for these is, unfortunately, volatile. If you believe you see a - miscategorized item, please let us know on the Bungie API forums.

        -

        Mapped to IDestinyItemCategoryDefinition in the manifest.

        -
        -
        -
        - -

        itemSubType

        -
        itemSubType: DestinyItemSubType
        - -
        -
        -

        A value indicating the "sub-type" of the item. For instance, where an item might - have an itemType value "Weapon", this will be something more specific like "Auto - Rifle".

        -
        -

        itemCategoryHashes are the preferred way of identifying types, we have retained - this enum for its convenience.

        -
        -
        -
        - -

        itemType

        -
        itemType: DestinyItemType
        - -
        -
        -

        A value indicating the "base" the of the item. This enum is a useful but - dramatic oversimplification of what it means for an item to have a "Type". Still, - it's handy in many situations.

        -
        -

        itemCategoryHashes are the preferred way of identifying types, we have retained - this enum for its convenience.

        -
        -
        -
        - -

        itemTypeAndTierDisplayName

        -
        itemTypeAndTierDisplayName: string
        - -
        -
        -

        It became a common enough pattern in our UI to show Item Type and Tier combined - into a single localized string that I'm just going to go ahead and start pre- - creating these for items.

        -
        -
        -
        -
        - -

        itemTypeDisplayName

        -
        itemTypeDisplayName: string
        - -
        -
        -

        The localized title/name of the item's type. This can be whatever the designers - want, and has no guarantee of consistency between items.

        -
        -
        -
        -
        - -

        links

        - - -
        -
        -

        If we added any help or informational URLs about this item, these will be those - links.

        -
        -
        -
        -
        - -

        Optional loreHash

        -
        loreHash: number
        - -
        -
        -

        If the item has any related Lore (DestinyLoreDefinition), this will be the hash - identifier you can use to look up the lore definition.

        -
        -

        Mapped to IDestinyLoreDefinition in the manifest.

        -
        -
        -
        - -

        nonTransferrable

        -
        nonTransferrable: boolean
        - -
        -
        -

        The intrinsic transferability of an item.

        -
        -

        I hate that this boolean is negative - but there's a reason.

        -

        Just because an item is intrinsically transferrable doesn't mean that it can be - transferred, and we don't want to imply that this is the only source of that - transferability.

        -
        -
        -
        - -

        objectives

        - - -
        -
        -

        If this item has Objectives (extra tasks that can be accomplished related to the - item... most frequently when the item is a Quest Step and the Objectives need to - be completed to move on to the next Quest Step), this block will be non-null and - the objectives defined herein.

        -
        -
        -
        -
        - -

        perks

        - - -
        -
        -

        If the item has any intrinsic Perks (Perks that it will provide regardless of - Sockets, Talent Grid, and other transitory state), they will be defined here.

        -
        -
        -
        -
        - -

        plug

        - - -
        -
        -

        If this item is a Plug, this will be non-null and the info defined herein. See - DestinyItemPlugDefinition for more information.

        -
        -
        -
        -
        - -

        preview

        - - -
        -
        -

        If this item can be Used or Acquired to gain other items (for instance, how - Eververse Boxes can be consumed to get items from the box), this block will be - non-null and will give summary information for the items that can be acquired.

        -
        -
        -
        -
        - -

        quality

        - - -
        -
        -

        If this item can have a level or stats, this block will be non-null and will be - populated with default quality (item level, "quality", and infusion) data. See - the block for more details, there's often less upfront information in D2 so you' - ll want to be aware of how you use quality and item level on the definition - level now.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        sack

        - - -
        -
        -

        If this item is a "reward sack" that can be opened to provide other items, this - will be non-null and the properties of the sack contained herein.

        -
        -
        -
        -
        - -

        screenshot

        -
        screenshot: string
        - -
        -
        -

        If we were able to acquire an in-game screenshot for the item, the path to that - screenshot will be returned here. Note that not all items have screenshots: - particularly not any non-equippable items.

        -
        -
        -
        -
        - -

        secondaryIcon

        -
        secondaryIcon: string
        - -
        -
        -

        A secondary icon associated with the item. Currently this is used in very - context specific applications, such as Emblem Nameplates.

        -
        -
        -
        -
        - -

        secondaryOverlay

        -
        secondaryOverlay: string
        - -
        -
        -

        Pulled from the secondary icon, this is the "secondary background" of the - secondary icon. Confusing? Sure, that's why I call it "overlay" here: because as - far as it's been used thus far, it has been for an optional overlay image. We'll - see if that holds up, but at least for now it explains what this image is a bit - better.

        -
        -
        -
        -
        - -

        secondarySpecial

        -
        secondarySpecial: string
        - -
        -
        -

        Pulled from the Secondary Icon, this is the "special" background for the item. - For Emblems, this is the background image used on the Details view: but it need - not be limited to that for other types of items.

        -
        -
        -
        -
        - -

        setData

        - - -
        -
        -

        If this item is a quest, this block will be non-null. In practice, I wish I had - called this the Quest block, but at the time it wasn't clear to me whether it - would end up being used for purposes other than quests. It will contain data - about the steps in the quest, and mechanics we can use for displaying and - tracking the quest.

        -
        -
        -
        -
        - -

        sockets

        - - -
        -
        -

        If this item has any Sockets, this will be non-null and the individual sockets - on the item will be defined herein.

        -
        -
        -
        -
        - -

        sourceData

        - - -
        -
        -

        If this item has a known source, this block will be non-null and populated with - source information. Unfortunately, at this time we are not generating sources: - that is some aggressively manual work which we didn't have time for, and I'm - hoping to get back to at some point in the future.

        -
        -
        -
        -
        - -

        specialItemType

        -
        specialItemType: SpecialItemType
        - -
        -
        -

        In Destiny 1, we identified some items as having particular categories that we'd - like to know about for various internal logic purposes. These are defined in - SpecialItemType, and while these days the itemCategoryHashes are the preferred - way of identifying types, we have retained this enum for its convenience.

        -
        -
        -
        -
        - -

        stats

        - - -
        -
        -

        If this item can have stats (such as a weapon, armor, or vehicle), this block - will be non-null and populated with the stats found on the item.

        -
        -
        -
        -
        - -

        summary

        - - -
        -
        -

        Summary data about the item.

        -
        -
        -
        -
        - -

        Optional summaryItemHash

        -
        summaryItemHash: number
        - -
        -
        -

        There are times when the game will show you a "summary/vague" version of an item

        -
          -
        • such as a description of its type represented as a - DestinyInventoryItemDefinition - rather than display the item itself.
        • -
        -
        -

        This happens sometimes when summarizing possible rewards in a tooltip. This is - the item displayed instead, if it exists.

        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        talentGrid

        - - -
        -
        -

        If the item has a Talent Grid, this will be non-null and the properties of the - grid defined herein. Note that, while many items still have talent grids, the - only ones with meaningful Nodes still on them will be Subclass/"Build" items.

        -
        -
        -
        -
        - -

        tooltipStyle

        -
        tooltipStyle: string
        - -
        -
        -

        An identifier that the game UI uses to determine what type of tooltip to show - for the item. These have no corresponding definitions that BNet can link to: so - it'll be up to you to interpret and display your UI differently according to - these styles (or ignore it).

        -
        -
        -
        -
        - -

        translationBlock

        - - -
        -
        -

        If this item can be rendered, this block will be non-null and will be populated - with rendering information.

        -
        -
        -
        -
        - -

        uiItemDisplayStyle

        -
        uiItemDisplayStyle: string
        - -
        -
        -

        A string identifier that the game's UI uses to determine how the item should be - rendered in inventory screens and the like. This could really be anything - at - the moment, we don't have the time to really breakdown and maintain all the - possible strings this could be, partly because new ones could be added ad hoc. - But if you want to use it to dictate your own UI, or look for items with a - certain display style, go for it!

        -
        -
        -
        -
        - -

        value

        - - -
        -
        -

        The conceptual "Value" of an item, if any was defined. See the - DestinyItemValueBlockDefinition for more details.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyinventoryitemstatdefinition.html b/docs/interfaces/idestinyinventoryitemstatdefinition.html deleted file mode 100644 index e726036..0000000 --- a/docs/interfaces/idestinyinventoryitemstatdefinition.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - - IDestinyInventoryItemStatDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyInventoryItemStatDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Defines a specific stat value on an item, and the minimum/maximum range that we - could compute for the item based on our heuristics for how the item might be - generated.

        -
        -

        Not guaranteed to match real-world instances of the item, but should hopefully - at least be close. If it's not close, let us know on the Bungie API forums.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyInventoryItemStatDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        maximum

        -
        maximum: number
        - -
        -
        -

        The maximum possible value for this stat that we think the item can roll.

        -
        -

        WARNING: In Destiny 1, this field was calculated using the potential stat rolls - on the item's talent grid. In Destiny 2, items no longer have meaningful talent - grids and instead have sockets: but the calculation of this field was never - altered to adapt to this change. As such, this field should be considered - deprecated until we can address this oversight.

        -
        -
        -
        - -

        minimum

        -
        minimum: number
        - -
        -
        -

        The minimum possible value for this stat that we think the item can roll.

        -
        -
        -
        -
        - -

        statHash

        -
        statHash: number
        - -
        -
        -

        The hash for the DestinyStatDefinition representing this stat.

        -
        -

        Mapped to IDestinyStatDefinition in the manifest.

        -
        -
        -
        - -

        value

        -
        value: number
        - -
        -
        -

        This value represents the stat value assuming the minimum possible roll but - accounting for any mandatory bonuses that should be applied to the stat on item - creation.

        -
        -

        In Destiny 1, this was different from the "minimum" value because there were - certain conditions where an item could be theoretically lower level/value than - the initial roll.

        -

        In Destiny 2, this is not possible unless Talent Grids begin to be used again - for these purposes or some other system change occurs... thus in practice, value - and minimum should be the same in Destiny 2. Good riddance.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemactionblockdefinition.html b/docs/interfaces/idestinyitemactionblockdefinition.html deleted file mode 100644 index 3a1a77d..0000000 --- a/docs/interfaces/idestinyitemactionblockdefinition.html +++ /dev/null @@ -1,463 +0,0 @@ - - - - - - IDestinyItemActionBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemActionBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If an item can have an action performed on it (like "Dismantle"), it will be - defined here if you care.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemActionBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        actionTypeLabel

        -
        actionTypeLabel: string
        - -
        -
        -

        The internal identifier for the action.

        -
        -
        -
        -
        - -

        consumeEntireStack

        -
        consumeEntireStack: boolean
        - -
        -
        -

        If true, the entire stack is deleted when the action completes.

        -
        -
        -
        -
        - -

        deleteOnAction

        -
        deleteOnAction: boolean
        - -
        -
        -

        If true, the item is deleted when the action completes.

        -
        -
        -
        -
        - -

        isPositive

        -
        isPositive: boolean
        - -
        -
        -

        The content has this property, however it's not entirely clear how it is used.

        -
        -
        -
        -
        - -

        overlayIcon

        -
        overlayIcon: string
        - -
        -
        -

        The icon associated with the overlay screen for the action, if any.

        -
        -
        -
        -
        - -

        overlayScreenName

        -
        overlayScreenName: string
        - -
        -
        -

        If the action has an overlay screen associated with it, this is the name of that - screen. Unfortunately, we cannot return the screen's data itself.

        -
        -
        -
        -
        - -

        progressionRewards

        - - -
        -
        -

        If performing this action earns you Progression, this is the list of - progressions and values granted for those progressions by performing this action.

        -
        -
        -
        -
        - -

        requiredCooldownHash

        -
        requiredCooldownHash: number
        - -
        -
        -

        The identifier hash for the Cooldown associated with this action. We have not - pulled this data yet for you to have more data to use for cooldowns.

        -
        -
        -
        -
        - -

        requiredCooldownSeconds

        -
        requiredCooldownSeconds: number
        - -
        -
        -

        The number of seconds to delay before allowing this action to be performed again.

        -
        -
        -
        -
        - -

        requiredItems

        - - -
        -
        -

        If the action requires other items to exist or be destroyed, this is the list of - those items and requirements.

        -
        -
        -
        -
        - -

        requiredLocation

        -
        requiredLocation: string
        - -
        -
        -

        Theoretically, an item could have a localized string for a hint about the - location in which the action should be performed. In practice, no items yet have - this property.

        -
        -
        -
        -
        - -

        useOnAcquire

        -
        useOnAcquire: boolean
        - -
        -
        -

        If true, this action will be performed as soon as you earn this item. Some - rewards work this way, providing you a single item to pick up from a reward- - granting vendor in-game and then immediately consuming itself to provide you - multiple items.

        -
        -
        -
        -
        - -

        verbDescription

        -
        verbDescription: string
        - -
        -
        -

        Localized text describing the action being performed.

        -
        -
        -
        -
        - -

        verbName

        -
        verbName: string
        - -
        -
        -

        Localized text for the verb of the action being performed.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemactionrequest.html b/docs/interfaces/idestinyitemactionrequest.html deleted file mode 100644 index 96336e8..0000000 --- a/docs/interfaces/idestinyitemactionrequest.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IDestinyItemActionRequest | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemActionRequest

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemActionRequest -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        characterId

        -
        characterId: string
        - -
        -
        - -

        itemId

        -
        itemId: string
        - -
        -
        - -

        membershipType

        -
        membershipType: BungieMembershipType
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemactionrequireditemdefinition.html b/docs/interfaces/idestinyitemactionrequireditemdefinition.html deleted file mode 100644 index 267da6f..0000000 --- a/docs/interfaces/idestinyitemactionrequireditemdefinition.html +++ /dev/null @@ -1,249 +0,0 @@ - - - - - - IDestinyItemActionRequiredItemDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemActionRequiredItemDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The definition of an item and quantity required in a character's inventory in - order to perform an action.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemActionRequiredItemDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        count

        -
        count: number
        - -
        -
        -

        The minimum quantity of the item you have to have.

        -
        -
        -
        -
        - -

        deleteOnAction

        -
        deleteOnAction: boolean
        - -
        -
        -

        If true, the item/quantity will be deleted from your inventory when the action - is performed. Otherwise, you'll retain these required items after the action is - complete.

        -
        -
        -
        -
        - -

        itemHash

        -
        itemHash: number
        - -
        -
        -

        The hash identifier of the item you need to have. Use it to look up the - DestinyInventoryItemDefinition for more info.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemcategorydefinition.html b/docs/interfaces/idestinyitemcategorydefinition.html deleted file mode 100644 index 46bceab..0000000 --- a/docs/interfaces/idestinyitemcategorydefinition.html +++ /dev/null @@ -1,549 +0,0 @@ - - - - - - IDestinyItemCategoryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemCategoryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        In an attempt to categorize items by type, usage, and other interesting - properties, we created DestinyItemCategoryDefinition: information about types - that is assembled using a set of heuristics that examine the properties of an - item such as what inventory bucket it's in, its item type name, and whether it - has or is missing certain blocks of data.

        -
        -

        This heuristic is imperfect, however. If you find an item miscategorized, let us - know on the Bungie API forums!

        -

        We then populate all of the categories that we think an item belongs to in its - DestinyInventoryItemDefinition.itemCategoryHashes property. You can use that to - provide your own custom item filtering, sorting, aggregating... go nuts on it! - And let us know if you see more categories that you wish would be added!

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemCategoryDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        deprecated

        -
        deprecated: boolean
        - -
        -
        -

        If True, this category has been deprecated: it may have no items left, or there - may be only legacy items that remain in it which are no longer relevant to the - game.

        -
        -
        -
        -
        - -

        displayProperties

        - - -
        -
        - -

        grantDestinyClass

        -
        grantDestinyClass: DestinyClass
        - -
        -
        -

        If an item belongs to this category, it will also get this class restriction - enum value.

        -
        -

        See the other "grant"-prefixed properties on this definition for my color - commentary.

        -
        -
        -
        - -

        grantDestinyItemType

        -
        grantDestinyItemType: DestinyItemType
        - -
        -
        -

        If an item belongs to this category, it will also receive this item type. This - is now how DestinyItemType is populated for items: it used to be an even jankier - process, but that's a story that requires more alcohol.

        -
        -
        -
        -
        - -

        grantDestinySubType

        -
        grantDestinySubType: DestinyItemSubType
        - -
        -
        -

        If an item belongs to this category, it will also receive this subtype enum - value.

        -
        -

        I know what you're thinking - what if it belongs to multiple categories that - provide sub-types?

        -

        The last one processed wins, as is the case with all of these "grant" enums. Now - you can see one reason why we moved away from these enums... but they're so - convenient when they work, aren't they?

        -
        -
        -
        - -

        groupCategoryOnly

        -
        groupCategoryOnly: boolean
        - -
        -
        -

        If true, this category is only used for grouping, and should not be evaluated - with its own checks. Rather, the item only has this category if it has one of - its child categories.

        -
        -
        -
        -
        - -

        groupedCategoryHashes

        -
        groupedCategoryHashes: number[]
        - -
        -
        -

        If this category is a "parent" category of other categories, those children will - have their hashes listed in rendering order here, and can be looked up using - these hashes against DestinyItemCategoryDefinition.

        -
        -

        In this way, you can build up a visual hierarchy of item categories. That's what - we did, and you can do it too. I believe in you. Yes, you, Carl.

        -

        (I hope someone named Carl reads this someday)

        -

        Mapped to IDestinyItemCategoryDefinition in the manifest.

        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        itemTypeRegex

        -
        itemTypeRegex: string
        - -
        -
        -

        The janky regular expression we used against the item type to try and discern - whether the item belongs to this category.

        -
        -
        -
        -
        - -

        itemTypeRegexNot

        -
        itemTypeRegexNot: string
        - -
        -
        -

        If the item type matches this janky regex, it does not belong to this category.

        -
        -
        -
        -
        - -

        originBucketIdentifier

        -
        originBucketIdentifier: string
        - -
        -
        -

        If the item belongs to this bucket, it does belong to this category.

        -
        -
        -
        -
        - -

        parentCategoryHashes

        -
        parentCategoryHashes: number[]
        - -
        -
        -

        All item category hashes of "parent" categories: categories that contain this as - a child through the hierarchy of groupedCategoryHashes. It's a bit redundant, - but having this child-centric list speeds up some calculations.

        -
        -
        -
        -
        - -

        plugCategoryIdentifier

        -
        plugCategoryIdentifier: string
        - -
        -
        -

        If the item is a plug, this is the identifier we expect to find associated with - it if it is in this category.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        shortTitle

        -
        shortTitle: string
        - -
        -
        -

        A shortened version of the title. The reason why we have this is because the - Armory in German had titles that were too long to display in our UI, so these - were localized abbreviated versions of those categories. The property still - exists today, even though the Armory doesn't exist for D2... yet.

        -
        -
        -
        -
        - -

        visible

        -
        visible: boolean
        - -
        -
        -

        If True, this category should be visible in UI. Sometimes we make categories - that we don't think are interesting externally. It's up to you if you want to - skip on showing them.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemchangeresponse.html b/docs/interfaces/idestinyitemchangeresponse.html deleted file mode 100644 index 0465e46..0000000 --- a/docs/interfaces/idestinyitemchangeresponse.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - - IDestinyItemChangeResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemChangeResponse

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemChangeResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        addedInventoryItems

        -
        addedInventoryItems: IDestinyItemComponent[]
        - -
        -
        -

        Items that appeared in the inventory possibly as a result of an action.

        -
        -
        -
        -
        - -

        item

        - - -
        -
        - -

        removedInventoryItems

        -
        removedInventoryItems: IDestinyItemComponent[]
        - -
        -
        -

        Items that disappeared from the inventory possibly as a result of an action.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemcomponent.html b/docs/interfaces/idestinyitemcomponent.html deleted file mode 100644 index 4bbf8a6..0000000 --- a/docs/interfaces/idestinyitemcomponent.html +++ /dev/null @@ -1,416 +0,0 @@ - - - - - - IDestinyItemComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The base item component, filled with properties that are generally useful to - know in any item request or that don't feel worthwhile to put in their own - component.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemComponent -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        bindStatus

        -
        bindStatus: ItemBindStatus
        - -
        -
        -

        If the item is bound to a location, it will be specified in this enum.

        -
        -
        -
        -
        - -

        bucketHash

        -
        bucketHash: number
        - -
        -
        -

        The hash identifier for the specific inventory bucket in which the item is - located.

        -
        -

        Mapped to IDestinyInventoryBucketDefinition in the manifest.

        -
        -
        -
        - -

        Optional expirationDate

        -
        expirationDate: string
        - -
        -
        -

        If the item can expire, this is the date at which it will/did expire.

        -
        -
        -
        -
        - -

        itemHash

        -
        itemHash: number
        - -
        -
        -

        The identifier for the item's definition, which is where most of the useful - static information for the item can be found.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        Optional itemInstanceId

        -
        itemInstanceId: string
        - -
        -
        -

        If the item is instanced, it will have an instance ID. Lack of an instance ID - implies that the item has no distinct local qualities aside from stack size.

        -
        -
        -
        -
        - -

        location

        -
        location: ItemLocation
        - -
        -
        -

        An easy reference for where the item is located. Redundant if you got the item - from an Inventory, but useful when making detail calls on specific items.

        -
        -
        -
        -
        - -

        lockable

        -
        lockable: boolean
        - -
        -
        -

        If the item can be locked, this will indicate that state.

        -
        -
        -
        -
        - -

        Optional overrideStyleItemHash

        -
        overrideStyleItemHash: number
        - -
        -
        -

        If populated, this is the hash of the item whose icon (and other secondary - styles, but not the human readable strings) should override whatever icons/ - styles are on the item being sold.

        -
        -

        If you don't do this, certain items whose styles are being overridden by - socketed items - such as the "Recycle Shader" item - would show whatever their - default icon/style is, and it wouldn't be pretty or look accurate.

        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        quantity

        -
        quantity: number
        - -
        -
        -

        The quantity of the item in this stack. Note that Instanced items cannot stack. - If an instanced item, this value will always be 1 (as the stack has exactly one - item in it)

        -
        -
        -
        -
        - -

        state

        -
        state: ItemState
        - -
        -
        -

        A flags enumeration indicating the transient/custom states of the item that - affect how it is rendered: whether it's tracked or locked for example, or - whether it has a masterwork plug inserted.

        -
        -
        -
        -
        - -

        transferStatus

        -
        transferStatus: TransferStatuses
        - -
        -
        -

        If there is a known error state that would cause this item to not be - transferable, this Flags enum will indicate all of those error states. Otherwise, - it will be 0 (CanTransfer).

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemcomponentsetofint32.html b/docs/interfaces/idestinyitemcomponentsetofint32.html deleted file mode 100644 index 9f51697..0000000 --- a/docs/interfaces/idestinyitemcomponentsetofint32.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - IDestinyItemComponentSetOfint32 | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemComponentSetOfint32

        -
        -
        -
        -
        -
        - - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemcomponentsetofint64.html b/docs/interfaces/idestinyitemcomponentsetofint64.html deleted file mode 100644 index 8c4c000..0000000 --- a/docs/interfaces/idestinyitemcomponentsetofint64.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - IDestinyItemComponentSetOfint64 | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemComponentSetOfint64

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemComponentSetOfint64 -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        instances

        - - -
        -
        - -

        objectives

        - - -
        -
        - -

        perks

        - - -
        -
        - -

        plugStates

        - - -
        -
        - -

        renderData

        - - -
        -
        - -

        sockets

        - - -
        -
        - -

        stats

        - - -
        -
        - -

        talentGrids

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemcomponentsetofuint32.html b/docs/interfaces/idestinyitemcomponentsetofuint32.html deleted file mode 100644 index 11e4a96..0000000 --- a/docs/interfaces/idestinyitemcomponentsetofuint32.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - IDestinyItemComponentSetOfuint32 | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemComponentSetOfuint32

        -
        -
        -
        -
        -
        - - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemcreationentryleveldefinition.html b/docs/interfaces/idestinyitemcreationentryleveldefinition.html deleted file mode 100644 index 33c959f..0000000 --- a/docs/interfaces/idestinyitemcreationentryleveldefinition.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - - IDestinyItemCreationEntryLevelDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemCreationEntryLevelDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        An overly complicated wrapper for the item level at which the item should spawn.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemCreationEntryLevelDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        level

        -
        level: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemgearsetblockdefinition.html b/docs/interfaces/idestinyitemgearsetblockdefinition.html deleted file mode 100644 index 7433259..0000000 --- a/docs/interfaces/idestinyitemgearsetblockdefinition.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - - IDestinyItemGearsetBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemGearsetBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If an item has a related gearset, this is the list of items in that set, and an - unlock expression that evaluates to a number representing the progress toward - gearset completion (a very rare use for unlock expressions!)

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemGearsetBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        itemList

        -
        itemList: number[]
        - -
        -
        -

        The list of hashes for items in the gearset. Use them to look up - DestinyInventoryItemDefinition entries for the items in the set.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        trackingValueMax

        -
        trackingValueMax: number
        - -
        -
        -

        The maximum possible number of items that can be collected.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyiteminstancecomponent.html b/docs/interfaces/idestinyiteminstancecomponent.html deleted file mode 100644 index 8857e7a..0000000 --- a/docs/interfaces/idestinyiteminstancecomponent.html +++ /dev/null @@ -1,402 +0,0 @@ - - - - - - IDestinyItemInstanceComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemInstanceComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If an item is "instanced", this will contain information about the item's - instance that doesn't fit easily into other components. One might say this is - the "essential" instance data for the item.

        -
        -

        Items are instanced if they require information or state that can vary. For - instance, weapons are Instanced: they are given a unique identifier, uniquely - generated stats, and can have their properties altered. Non-instanced items have - none of these things: for instance, Glimmer has no unique properties aside from - how much of it you own.

        -

        You can tell from an item's definition whether it will be instanced or not by - looking at the DestinyInventoryItemDefinition's definition.inventory. - isInstanceItem property.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemInstanceComponent -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        canEquip

        -
        canEquip: boolean
        - -
        -
        -

        If this is an equippable item, you can check it here. There are permanent as - well as transitory reasons why an item might not be able to be equipped: check - cannotEquipReason for details.

        -
        -
        -
        -
        - -

        cannotEquipReason

        -
        cannotEquipReason: EquipFailureReason
        - -
        -
        -

        If you cannot equip the item, this is a flags enum that enumerates all of the - reasons why you couldn't equip the item. You may need to refine your UI further - by using unlockHashesRequiredToEquip and equipRequiredLevel.

        -
        -
        -
        -
        - -

        damageType

        -
        damageType: DamageType
        - -
        -
        -

        If the item has a damage type, this is the item's current damage type.

        -
        -
        -
        -
        - -

        Optional damageTypeHash

        -
        damageTypeHash: number
        - -
        -
        -

        The current damage type's hash, so you can look up localized info and icons for - it.

        -
        -

        Mapped to IDestinyDamageTypeDefinition in the manifest.

        -
        -
        -
        - -

        equipRequiredLevel

        -
        equipRequiredLevel: number
        - -
        -
        -

        If the item cannot be equipped until you reach a certain level, that level will - be reflected here.

        -
        -
        -
        -
        - -

        isEquipped

        -
        isEquipped: boolean
        - -
        -
        -

        Is the item currently equipped on the given character?

        -
        -
        -
        -
        - -

        itemLevel

        -
        itemLevel: number
        - -
        -
        -

        The Item's "Level" has the most significant bearing on its stats, such as Light - and Power.

        -
        -
        -
        -
        - -

        primaryStat

        -
        primaryStat: IDestinyStat
        - -
        -
        -

        The item stat that we consider to be "primary" for the item. For instance, this - would be "Attack" for Weapons or "Defense" for armor.

        -
        -
        -
        -
        - -

        quality

        -
        quality: number
        - -
        -
        -

        The "Quality" of the item has a lesser - but still impactful - bearing on stats - like Light and Power.

        -
        -
        -
        -
        - -

        unlockHashesRequiredToEquip

        -
        unlockHashesRequiredToEquip: number[]
        - -
        -
        -

        Sometimes, there are limitations to equipping that are represented by character- - level flags called "unlocks".

        -
        -

        This is a list of flags that they need in order to equip the item that the - character has not met. Use these to look up the descriptions to show in your UI - by looking up the relevant DestinyUnlockDefinitions for the hashes.

        -

        Mapped to IDestinyUnlockDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemintrinsicsocketentrydefinition.html b/docs/interfaces/idestinyitemintrinsicsocketentrydefinition.html deleted file mode 100644 index 67d4c06..0000000 --- a/docs/interfaces/idestinyitemintrinsicsocketentrydefinition.html +++ /dev/null @@ -1,253 +0,0 @@ - - - - - - IDestinyItemIntrinsicSocketEntryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemIntrinsicSocketEntryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents a socket that has a plug associated with it intrinsically. This is - useful for situations where the weapon needs to have a visual plug/Mod on it, - but that plug/Mod should never change.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemIntrinsicSocketEntryDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        defaultVisible

        -
        defaultVisible: boolean
        - -
        -
        -

        If true, then this socket is visible in the item's "default" state. If you have - an instance, you should always check the runtime state, as that can override - this visibility setting: but if you're looking at the item on a conceptual level, - this property can be useful for hiding data such as legacy sockets - which - remain defined on items for infrastructure purposes, but can be confusing for - users to see.

        -
        -
        -
        -
        - -

        plugItemHash

        -
        plugItemHash: number
        - -
        -
        -

        Indicates the plug that is intrinsically inserted into this socket.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        socketTypeHash

        -
        socketTypeHash: number
        - -
        -
        -

        Indicates the type of this intrinsic socket.

        -
        -

        Mapped to IDestinySocketTypeDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyiteminventoryblockdefinition.html b/docs/interfaces/idestinyiteminventoryblockdefinition.html deleted file mode 100644 index beae550..0000000 --- a/docs/interfaces/idestinyiteminventoryblockdefinition.html +++ /dev/null @@ -1,428 +0,0 @@ - - - - - - IDestinyItemInventoryBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemInventoryBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If the item can exist in an inventory - the overwhelming majority of them can - and do - then this is the basic properties regarding the item's relationship - with the inventory.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemInventoryBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        bucketTypeHash

        -
        bucketTypeHash: number
        - -
        -
        -

        The hash identifier for the DestinyInventoryBucketDefinition to which this item - belongs. I should have named this "bucketHash", but too many things refer to it - now. Sigh.

        -
        -

        Mapped to IDestinyInventoryBucketDefinition in the manifest.

        -
        -
        -
        - -

        expirationTooltip

        -
        expirationTooltip: string
        - -
        -
        -

        The tooltip message to show, if any, when the item expires.

        -
        -
        -
        -
        - -

        expiredInActivityMessage

        -
        expiredInActivityMessage: string
        - -
        -
        -

        If the item expires while playing in an activity, we show a different message.

        -
        -
        -
        -
        - -

        expiredInOrbitMessage

        -
        expiredInOrbitMessage: string
        - -
        -
        -

        If the item expires in orbit, we show a... more different message. ("Consummate - V's, consummate!")

        -
        -
        -
        -
        - -

        isInstanceItem

        -
        isInstanceItem: boolean
        - -
        -
        -

        If TRUE, this item is instanced. Otherwise, it is a generic item that merely has - a quantity in a stack (like Glimmer).

        -
        -
        -
        -
        - -

        maxStackSize

        -
        maxStackSize: number
        - -
        -
        -

        The maximum quantity of this item that can exist in a stack.

        -
        -
        -
        -
        - -

        recoveryBucketTypeHash

        -
        recoveryBucketTypeHash: number
        - -
        -
        -

        If the item is picked up by the lost loot queue, this is the hash identifier for - the DestinyInventoryBucketDefinition into which it will be placed. Again, I - should have named this recoveryBucketHash instead.

        -
        -

        Mapped to IDestinyInventoryBucketDefinition in the manifest.

        -
        -
        -
        - -

        stackUniqueLabel

        -
        stackUniqueLabel: string
        - -
        -
        -

        If this string is populated, you can't have more than one stack with this label - in a given inventory. Note that this is different from the equipping block's - unique label, which is used for equipping uniqueness.

        -
        -
        -
        -
        - -

        suppressExpirationWhenObjectivesComplete

        -
        suppressExpirationWhenObjectivesComplete: boolean
        - -
        -
        - -

        tierType

        -
        tierType: TierType
        - -
        -
        -

        The enumeration matching the tier type of the item to known values, again for - convenience sake.

        -
        -
        -
        -
        - -

        tierTypeHash

        -
        tierTypeHash: number
        - -
        -
        -

        The hash identifier for the Tier Type of the item, use to look up its - DestinyItemTierTypeDefinition if you need to show localized data for the item's - tier.

        -
        -

        Mapped to IDestinyItemTierTypeDefinition in the manifest.

        -
        -
        -
        - -

        tierTypeName

        -
        tierTypeName: string
        - -
        -
        -

        The localized name of the tier type, which is a useful shortcut so you don't - have to look up the definition every time. However, it's mostly a holdover from - days before we had a DestinyItemTierTypeDefinition to refer to.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyiteminvestmentstatdefinition.html b/docs/interfaces/idestinyiteminvestmentstatdefinition.html deleted file mode 100644 index 30a1066..0000000 --- a/docs/interfaces/idestinyiteminvestmentstatdefinition.html +++ /dev/null @@ -1,257 +0,0 @@ - - - - - - IDestinyItemInvestmentStatDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemInvestmentStatDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents a "raw" investment stat, before calculated stats are calculated and - before any DestinyStatGroupDefinition is applied to transform the stat into - something closer to what you see in-game.

        -
        -

        Because these won't match what you see in-game, consider carefully whether you - really want to use these stats. I have left them in case someone can do - something useful or interesting with the pre-processed statistics.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemInvestmentStatDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        isConditionallyActive

        -
        isConditionallyActive: boolean
        - -
        -
        -

        If this is true, the stat will only be applied on the item in certain game state - conditions, and we can't know statically whether or not this stat will be - applied. Check the "live" API data instead for whether this value is being - applied on a specific instance of the item in question, and you can use this to - decide whether you want to show the stat on the generic view of the item, or - whether you want to show some kind of caveat or warning about the stat value - being conditional on game state.

        -
        -
        -
        -
        - -

        statTypeHash

        -
        statTypeHash: number
        - -
        -
        -

        The hash identifier for the DestinyStatDefinition defining this stat.

        -
        -

        Mapped to IDestinyStatDefinition in the manifest.

        -
        -
        -
        - -

        value

        -
        value: number
        - -
        -
        -

        The raw "Investment" value for the stat, before transformations are performed to - turn this raw stat into stats that are displayed in the game UI.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemobjectiveblockdefinition.html b/docs/interfaces/idestinyitemobjectiveblockdefinition.html deleted file mode 100644 index e50505e..0000000 --- a/docs/interfaces/idestinyitemobjectiveblockdefinition.html +++ /dev/null @@ -1,376 +0,0 @@ - - - - - - IDestinyItemObjectiveBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemObjectiveBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        An item can have objectives on it. In practice, these are the exclusive purview - of "Quest Step" items: DestinyInventoryItemDefinitions that represent a specific - step in a Quest.

        -
        -

        Quest steps have 1:M objectives that we end up processing and returning in live - data as DestinyQuestStatus data, and other useful information.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemObjectiveBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        displayActivityHashes

        -
        displayActivityHashes: number[]
        - -
        -
        -

        For every entry in objectiveHashes, there is a corresponding entry in this array - at the same index. If the objective is meant to be associated with a specific - DestinyActivityDefinition, there will be a valid hash at that index. Otherwise, - it will be invalid (0).

        -
        -

        Rendered somewhat obsolete by perObjectiveDisplayProperties, which currently has - much the same information but may end up with more info in the future.

        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        narrative

        -
        narrative: string
        - -
        -
        -

        The localized string for narrative text related to this quest step, if any.

        -
        -
        -
        -
        - -

        objectiveHashes

        -
        objectiveHashes: number[]
        - -
        -
        -

        The hashes to Objectives (DestinyObjectiveDefinition) that are part of this - Quest Step, in the order that they should be rendered.

        -
        -

        Mapped to IDestinyObjectiveDefinition in the manifest.

        -
        -
        -
        - -

        objectiveVerbName

        -
        objectiveVerbName: string
        - -
        -
        -

        The localized string describing an action to be performed associated with the - objectives, if any.

        -
        -
        -
        -
        - -

        perObjectiveDisplayProperties

        -
        perObjectiveDisplayProperties: IDestinyObjectiveDisplayProperties[]
        - -
        -
        -

        One entry per Objective on the item, it will have related display information.

        -
        -
        -
        -
        - -

        questTypeHash

        -
        questTypeHash: number
        - -
        -
        -

        A hashed value for the questTypeIdentifier, because apparently I like to be - redundant.

        -
        -
        -
        -
        - -

        questTypeIdentifier

        -
        questTypeIdentifier: string
        - -
        -
        -

        The identifier for the type of quest being performed, if any. Not associated - with any fixed definition, yet.

        -
        -
        -
        -
        - -

        questlineItemHash

        -
        questlineItemHash: number
        - -
        -
        -

        The hash for the DestinyInventoryItemDefinition representing the Quest to which - this Quest Step belongs.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        requireFullObjectiveCompletion

        -
        requireFullObjectiveCompletion: boolean
        - -
        -
        -

        If True, all objectives must be completed for the step to be completed. If False, - any one objective can be completed for the step to be completed.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemobjectivescomponent.html b/docs/interfaces/idestinyitemobjectivescomponent.html deleted file mode 100644 index 7acbde3..0000000 --- a/docs/interfaces/idestinyitemobjectivescomponent.html +++ /dev/null @@ -1,253 +0,0 @@ - - - - - - IDestinyItemObjectivesComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemObjectivesComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Items can have objectives and progression. When you request this block, you will - obtain information about any Objectives and progression tied to this item.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemObjectivesComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        Optional dateCompleted

        -
        dateCompleted: string
        - -
        -
        -

        If we have any information on when these objectives were completed, this will be - the date of that completion. This won't be on many items, but could be - interesting for some items that do store this information.

        -
        -
        -
        -
        - -

        flavorObjective

        -
        flavorObjective: IDestinyObjectiveProgress
        - -
        -
        -

        I may regret naming it this way - but this represents when an item has an - objective that doesn't serve a beneficial purpose, but rather is used for " - flavor" or additional information. For instance, when Emblems track specific - stats, those stats are represented as Objectives on the item.

        -
        -
        -
        -
        - -

        objectives

        - - -
        -
        -

        If the item has a hard association with objectives, your progress on them will - be defined here.

        -
        -

        Objectives are our standard way to describe a series of tasks that have to be - completed for a reward.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitempeerview.html b/docs/interfaces/idestinyitempeerview.html deleted file mode 100644 index 8db7e5e..0000000 --- a/docs/interfaces/idestinyitempeerview.html +++ /dev/null @@ -1,228 +0,0 @@ - - - - - - IDestinyItemPeerView | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemPeerView

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Bare minimum summary information for an item, for the sake of 3D rendering the - item.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemPeerView -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        dyes

        - - -
        -
        -

        The list of dyes that have been applied to this item.

        -
        -
        -
        -
        - -

        itemHash

        -
        itemHash: number
        - -
        -
        -

        The hash identifier of the item in question. Use it to look up the - DestinyInventoryItemDefinition of the item for static rendering data.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemperkentrydefinition.html b/docs/interfaces/idestinyitemperkentrydefinition.html deleted file mode 100644 index 91d2722..0000000 --- a/docs/interfaces/idestinyitemperkentrydefinition.html +++ /dev/null @@ -1,247 +0,0 @@ - - - - - - IDestinyItemPerkEntryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemPerkEntryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        An intrinsic perk on an item, and the requirements for it to be activated.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemPerkEntryDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        perkHash

        -
        perkHash: number
        - -
        -
        -

        A hash identifier for the DestinySandboxPerkDefinition being provided on the - item.

        -
        -

        Mapped to IDestinySandboxPerkDefinition in the manifest.

        -
        -
        -
        - -

        perkVisibility

        -
        perkVisibility: ItemPerkVisibility
        - -
        -
        -

        Indicates whether this perk should be shown, or if it should be shown disabled.

        -
        -
        -
        -
        - -

        requirementDisplayString

        -
        requirementDisplayString: string
        - -
        -
        -

        If this perk is not active, this is the string to show for why it's not - providing its benefits.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemperkscomponent.html b/docs/interfaces/idestinyitemperkscomponent.html deleted file mode 100644 index f35d230..0000000 --- a/docs/interfaces/idestinyitemperkscomponent.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - IDestinyItemPerksComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemPerksComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Instanced items can have perks: benefits that the item bestows.

        -
        -

        These are related to DestinySandboxPerkDefinition, and sometimes - but not - always - have human readable info. When they do, they are the icons and text - that you see in an item's tooltip.

        -

        Talent Grids, Sockets, and the item itself can apply Perks, which are then - summarized here for your convenience.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemPerksComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        perks

        - - -
        -
        -

        The list of perks to display in an item tooltip - and whether or not they have - been activated.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemplug.html b/docs/interfaces/idestinyitemplug.html deleted file mode 100644 index 7dbfb95..0000000 --- a/docs/interfaces/idestinyitemplug.html +++ /dev/null @@ -1,310 +0,0 @@ - - - - - - IDestinyItemPlug | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemPlug

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemPlug -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        canInsert

        -
        canInsert: boolean
        - -
        -
        -

        If true, this plug has met all of its insertion requirements. Big if true.

        -
        -
        -
        -
        - -

        enableFailIndexes

        -
        enableFailIndexes: number[]
        - -
        -
        -

        If a plug is not enabled, this will be populated with indexes into the plug item - definition's plug.enabledRules property, so that you can show the reasons why it - is not enabled.

        -
        -

        This list will be empty if the plug is enabled.

        -
        -
        -
        - -

        enabled

        -
        enabled: boolean
        - -
        -
        -

        If true, this plug will provide its benefits while inserted.

        -
        -
        -
        -
        - -

        insertFailIndexes

        -
        insertFailIndexes: number[]
        - -
        -
        -

        If the plug cannot be inserted for some reason, this will have the indexes into - the plug item definition's plug.insertionRules property, so you can show the - reasons why it can't be inserted.

        -
        -

        This list will be empty if the plug can be inserted.

        -
        -
        -
        - -

        plugItemHash

        -
        plugItemHash: number
        - -
        -
        -

        The hash identifier of the DestinyInventoryItemDefinition that represents this - plug.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        plugObjectives

        -
        plugObjectives: IDestinyObjectiveProgress[]
        - -
        -
        -

        Sometimes, Plugs may have objectives: these are often used for flavor and - display purposes, but they can be used for any arbitrary purpose (both - fortunately and unfortunately). Recently (with Season 2) they were expanded in - use to be used as the "gating" for whether the plug can be inserted at all. For - instance, a Plug might be tracking the number of PVP kills you have made. It - will use the parent item's data about that tracking status to determine what to - show, and will generally show it using the DestinyObjectiveDefinition's - progressDescription property. Refer to the plug's itemHash and objective - property for more information if you would like to display even more data.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemplugcomponent.html b/docs/interfaces/idestinyitemplugcomponent.html deleted file mode 100644 index e2d2c19..0000000 --- a/docs/interfaces/idestinyitemplugcomponent.html +++ /dev/null @@ -1,322 +0,0 @@ - - - - - - IDestinyItemPlugComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemPlugComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Plugs are non-instanced items that can provide Stat and Perk benefits when - socketed into an instanced item. Items have Sockets, and Plugs are inserted into - Sockets.

        -
        -

        This component finds all items that are considered "Plugs" in your inventory, - and return information about the plug aside from any specific Socket into which - it could be inserted.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemPlugComponent -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        canInsert

        -
        canInsert: boolean
        - -
        -
        -

        If true, this plug has met all of its insertion requirements. Big if true.

        -
        -
        -
        -
        - -

        enableFailIndexes

        -
        enableFailIndexes: number[]
        - -
        -
        -

        If a plug is not enabled, this will be populated with indexes into the plug item - definition's plug.enabledRules property, so that you can show the reasons why it - is not enabled.

        -
        -

        This list will be empty if the plug is enabled.

        -
        -
        -
        - -

        enabled

        -
        enabled: boolean
        - -
        -
        -

        If true, this plug will provide its benefits while inserted.

        -
        -
        -
        -
        - -

        insertFailIndexes

        -
        insertFailIndexes: number[]
        - -
        -
        -

        If the plug cannot be inserted for some reason, this will have the indexes into - the plug item definition's plug.insertionRules property, so you can show the - reasons why it can't be inserted.

        -
        -

        This list will be empty if the plug can be inserted.

        -
        -
        -
        - -

        plugItemHash

        -
        plugItemHash: number
        - -
        -
        -

        The hash identifier of the DestinyInventoryItemDefinition that represents this - plug.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        plugObjectives

        -
        plugObjectives: IDestinyObjectiveProgress[]
        - -
        -
        -

        Sometimes, Plugs may have objectives: these are often used for flavor and - display purposes, but they can be used for any arbitrary purpose (both - fortunately and unfortunately). Recently (with Season 2) they were expanded in - use to be used as the "gating" for whether the plug can be inserted at all. For - instance, a Plug might be tracking the number of PVP kills you have made. It - will use the parent item's data about that tracking status to determine what to - show, and will generally show it using the DestinyObjectiveDefinition's - progressDescription property. Refer to the plug's itemHash and objective - property for more information if you would like to display even more data.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemplugdefinition.html b/docs/interfaces/idestinyitemplugdefinition.html deleted file mode 100644 index d391b35..0000000 --- a/docs/interfaces/idestinyitemplugdefinition.html +++ /dev/null @@ -1,528 +0,0 @@ - - - - - - IDestinyItemPlugDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemPlugDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If an item is a Plug, its DestinyInventoryItemDefinition.plug property will be - populated with an instance of one of these bad boys.

        -
        -

        This gives information about when it can be inserted, what the plug's category - is (and thus whether it is compatible with a socket... see - DestinySocketTypeDefinition for information about Plug Categories and socket - compatibility), whether it is enabled and other Plug info.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemPlugDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        alternatePlugStyle

        -
        alternatePlugStyle: PlugUiStyles
        - -
        -
        -

        The alternate plug of the plug: only applies when the item is in states that - only the server can know about and control, unfortunately. See - AlternateUiPlugLabel for the related label info.

        -
        -
        -
        -
        - -

        alternateUiPlugLabel

        -
        alternateUiPlugLabel: string
        - -
        -
        -

        If the plug meets certain state requirements, it may have an alternative label - applied to it. This is the alternative label that will be applied in such a - situation.

        -
        -
        -
        -
        - -

        enabledMaterialRequirementHash

        -
        enabledMaterialRequirementHash: number
        - -
        -
        -

        It's not enough for the plug to be inserted. It has to be enabled as well. For - it to be enabled, it may require materials. This is the hash identifier for the - DestinyMaterialRequirementSetDefinition for those requirements, if there is one.

        -
        -

        Mapped to IDestinyMaterialRequirementSetDefinition in the manifest.

        -
        -
        -
        - -

        enabledRules

        - - -
        -
        -

        The rules around whether the plug, once inserted, is enabled and providing its - benefits.

        -
        -

        The live data DestinyItemPlugComponent.enableFailIndexes will be an index into - this array, so you can pull out the failure strings appropriate for the user.

        -
        -
        -
        - -

        insertionMaterialRequirementHash

        -
        insertionMaterialRequirementHash: number
        - -
        -
        -

        If inserting this plug requires materials, this is the hash identifier for - looking up the DestinyMaterialRequirementSetDefinition for those requirements.

        -
        -

        Mapped to IDestinyMaterialRequirementSetDefinition in the manifest.

        -
        -
        -
        - -

        insertionRules

        -
        insertionRules: IDestinyPlugRuleDefinition[]
        - -
        -
        -

        The rules around when this plug can be inserted into a socket, aside from the - socket's individual restrictions.

        -
        -

        The live data DestinyItemPlugComponent.insertFailIndexes will be an index into - this array, so you can pull out the failure strings appropriate for the user.

        -
        -
        -
        - -

        isDummyPlug

        -
        isDummyPlug: boolean
        - -
        -
        -

        If TRUE, this plug is used for UI display purposes only, and doesn't have any - interesting effects of its own.

        -
        -
        -
        -
        - -

        isPseudoPlug

        -
        isPseudoPlug: boolean
        - -
        -
        -

        If TRUE, the plug doesn't actually convey any benefit: it only exists to show - information in the UI.

        -
        -
        -
        -
        - -

        onActionRecreateSelf

        -
        onActionRecreateSelf: boolean
        - -
        -
        -

        If you successfully socket the item, this will determine whether or not you get " - refunded" on the plug.

        -
        -
        -
        -
        - -

        parentItemOverride

        -
        parentItemOverride: IDestinyParentItemOverride
        - -
        -
        -

        Do you ever get the feeling that a system has become so overburdened by edge - cases that it probably should have become some other system entirely? So do I!

        -
        -

        In totally unrelated news, Plugs can now override properties of their parent - items. This is some of the relevant definition data for those overrides.

        -

        If this is populated, it will have the override data to be applied when this - plug is applied to an item.

        -
        -
        -
        - -

        plugAvailability

        -
        plugAvailability: PlugAvailabilityMode
        - -
        -
        -

        Indicates the rules about when this plug can be used. See the - PlugAvailabilityMode enumeration for more information!

        -
        -
        -
        -
        - -

        plugCategoryHash

        -
        plugCategoryHash: number
        - -
        -
        -

        The hash for the plugCategoryIdentifier. You can use this instead if you wish: I - put both in the definition for debugging purposes.

        -
        -
        -
        -
        - -

        plugCategoryIdentifier

        -
        plugCategoryIdentifier: string
        - -
        -
        -

        The string identifier for the plug's category. Use the socket's - DestinySocketTypeDefinition.plugWhitelist to determine whether this plug can be - inserted into the socket.

        -
        -
        -
        -
        - -

        plugStyle

        -
        plugStyle: PlugUiStyles
        - -
        -
        - -

        previewItemOverrideHash

        -
        previewItemOverrideHash: number
        - -
        -
        -

        In the game, if you're inspecting a plug item directly, this will be the item - shown with the plug attached. Look up the DestinyInventoryItemDefinition for - this hash for the item.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        uiPlugLabel

        -
        uiPlugLabel: string
        - -
        -
        -

        Plugs can have arbitrary, UI-defined identifiers that the UI designers use to - determine the style applied to plugs. Unfortunately, we have neither a - definitive list of these labels nor advance warning of when new labels might be - applied or how that relates to how they get rendered. If you want to, you can - refer to known labels to change your own styles: but know that new ones can be - created arbitrarily, and we have no way of associating the labels with any - specific UI style guidance... you'll have to piece that together on your end. Or - do what we do, and just show plugs more generically, without specialized styles.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitempreviewblockdefinition.html b/docs/interfaces/idestinyitempreviewblockdefinition.html deleted file mode 100644 index 50cc31e..0000000 --- a/docs/interfaces/idestinyitempreviewblockdefinition.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - IDestinyItemPreviewBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemPreviewBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Items like Sacks or Boxes can have items that it shows in-game when you view - details that represent the items you can obtain if you use or acquire the item.

        -
        -

        This defines those categories, and gives some insights into that data's source.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemPreviewBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        derivedItemCategories

        -
        derivedItemCategories: IDestinyDerivedItemCategoryDefinition[]
        - -
        -
        -

        This is a list of the items being previewed, categorized in the same way as they - are in the preview UI.

        -
        -
        -
        -
        - -

        previewActionString

        -
        previewActionString: string
        - -
        -
        -

        If the preview has an associated action (like "Open"), this will be the - localized string for that action.

        -
        -
        -
        -
        - -

        previewVendorHash

        -
        previewVendorHash: number
        - -
        -
        -

        If the preview data is derived from a fake "Preview" Vendor, this will be the - hash identifier for the DestinyVendorDefinition of that fake vendor.

        -
        -

        Mapped to IDestinyVendorDefinition in the manifest.

        -
        -
        -
        - -

        screenStyle

        -
        screenStyle: string
        - -
        -
        -

        A string that the game UI uses as a hint for which detail screen to show for the - item. You, too, can leverage this for your own custom screen detail views. Note, - however, that these are arbitrarily defined by designers: there's no guarantees - of a fixed, known number of these - so fall back to something reasonable if you - don't recognize it.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemqualityblockdefinition.html b/docs/interfaces/idestinyitemqualityblockdefinition.html deleted file mode 100644 index 72790d2..0000000 --- a/docs/interfaces/idestinyitemqualityblockdefinition.html +++ /dev/null @@ -1,325 +0,0 @@ - - - - - - IDestinyItemQualityBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemQualityBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        An item's "Quality" determines its calculated stats. The Level at which the item - spawns is combined with its "qualityLevel" along with some additional - calculations to determine the value of those stats.

        -
        -

        In Destiny 2, most items don't have default item levels and quality, making this - property less useful: these apparently are almost always determined by the - complex mechanisms of the Reward system rather than statically. They are still - provided here in case they are still useful for people. This also contains some - information about Infusion.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemQualityBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        infusionCategoryHash

        -
        infusionCategoryHash: number
        - -
        -
        -

        The hash identifier for the infusion. It does not map to a Definition entity.

        -
        -

        DEPRECATED: Items can now have multiple infusion categories. Please use - infusionCategoryHashes instead.

        -
        -
        -
        - -

        infusionCategoryHashes

        -
        infusionCategoryHashes: number[]
        - -
        -
        -

        If any one of these hashes matches any value in another item's - infusionCategoryHashes, the two can infuse with each other.

        -
        -
        -
        -
        - -

        infusionCategoryName

        -
        infusionCategoryName: string
        - -
        -
        -

        The string identifier for this item's "infusability", if any.

        -
        -

        Items that match the same infusionCategoryName are allowed to infuse with each - other.

        -

        DEPRECATED: Items can now have multiple infusion categories. Please use - infusionCategoryHashes instead.

        -
        -
        -
        - -

        itemLevels

        -
        itemLevels: number[]
        - -
        -
        -

        The "base" defined level of an item. This is a list because, in theory, each - Expansion could define its own base level for an item.

        -
        -

        In practice, not only was that never done in Destiny 1, but now this isn't even - populated at all. When it's not populated, the level at which it spawns has to - be inferred by Reward information, of which BNet receives an imperfect view and - will only be reliable on instanced data as a result.

        -
        -
        -
        - -

        progressionLevelRequirementHash

        -
        progressionLevelRequirementHash: number
        - -
        -
        -

        An item can refer to pre-set level requirements. They are defined in - DestinyProgressionLevelRequirementDefinition, and you can use this hash to find - the appropriate definition.

        -
        -

        Mapped to IDestinyProgressionLevelRequirementDefinition in the manifest.

        -
        -
        -
        - -

        qualityLevel

        -
        qualityLevel: number
        - -
        -
        -

        qualityLevel is used in combination with the item's level to calculate stats - like Attack and Defense. It plays a role in that calculation, but not nearly as - large as itemLevel does.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemquantity.html b/docs/interfaces/idestinyitemquantity.html deleted file mode 100644 index d9b9cc4..0000000 --- a/docs/interfaces/idestinyitemquantity.html +++ /dev/null @@ -1,251 +0,0 @@ - - - - - - IDestinyItemQuantity | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemQuantity

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Used in a number of Destiny contracts to return data about an item stack and its - quantity. Can optionally return an itemInstanceId if the item is instanced - in - which case, the quantity returned will be 1. If it's not... uh, let me know okay? - Thanks.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemQuantity -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        itemHash

        -
        itemHash: number
        - -
        -
        -

        The hash identifier for the item in question. Use it to look up the item's - DestinyInventoryItemDefinition.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        Optional itemInstanceId

        -
        itemInstanceId: string
        - -
        -
        -

        If this quantity is referring to a specific instance of an item, this will have - the item's instance ID. Normally, this will be null.

        -
        -
        -
        -
        - -

        quantity

        -
        quantity: number
        - -
        -
        -

        The amount of the item needed/available depending on the context of where - DestinyItemQuantity is being used.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemrendercomponent.html b/docs/interfaces/idestinyitemrendercomponent.html deleted file mode 100644 index 0f98a57..0000000 --- a/docs/interfaces/idestinyitemrendercomponent.html +++ /dev/null @@ -1,237 +0,0 @@ - - - - - - IDestinyItemRenderComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemRenderComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Many items can be rendered in 3D. When you request this block, you will obtain - the custom data needed to render this specific instance of the item.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemRenderComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        artRegions

        -
        artRegions: object
        - -
        -
        -

        A dictionary for rendering gear components, with:

        -
        -

        key = Art Arrangement Region Index

        -

        value = The chosen Arrangement Index for the Region, based on the value of a - stat on the item used for making the choice.

        -
        -
        -

        Type declaration

        -
          -
        • -
          [key: number]: number
          -
        • -
        -
        -
        -
        - -

        useCustomDyes

        -
        useCustomDyes: boolean
        - -
        -
        -

        If you should use custom dyes on this item, it will be indicated here.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemresponse.html b/docs/interfaces/idestinyitemresponse.html deleted file mode 100644 index 7568ae7..0000000 --- a/docs/interfaces/idestinyitemresponse.html +++ /dev/null @@ -1,373 +0,0 @@ - - - - - - IDestinyItemResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemResponse

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The response object for retrieving an individual instanced item. None of these - components are relevant for an item that doesn't have an "itemInstanceId": for - those, get your information from the DestinyInventoryDefinition.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        Optional characterId

        -
        characterId: string
        - -
        -
        -

        If the item is on a character, this will return the ID of the character that is - holding the item.

        -
        -
        -
        -
        - -

        instance

        - - -
        -
        -

        Basic instance data for the item.

        -
        -

        COMPONENT TYPE: ItemInstances

        -
        -
        -
        - -

        item

        - - -
        -
        -

        Common data for the item relevant to its non-instanced properties.

        -
        -

        COMPONENT TYPE: ItemCommonData

        -
        -
        -
        - -

        objectives

        - - -
        -
        -

        Information specifically about the item's objectives.

        -
        -

        COMPONENT TYPE: ItemObjectives

        -
        -
        -
        - -

        perks

        - - -
        -
        -

        Information specifically about the perks currently active on the item.

        -
        -

        COMPONENT TYPE: ItemPerks

        -
        -
        -
        - -

        renderData

        - - -
        -
        -

        Information about how to render the item in 3D.

        -
        -

        COMPONENT TYPE: ItemRenderData

        -
        -
        -
        - -

        sockets

        - - -
        -
        -

        Information about the sockets of the item: which are currently active, what - potential sockets you could have and the stats/abilities/perks you can gain from - them.

        -
        -

        COMPONENT TYPE: ItemSockets

        -
        -
        -
        - -

        stats

        - - -
        -
        -

        Information about the computed stats of the item: power, defense, etc...

        -
        -

        COMPONENT TYPE: ItemStats

        -
        -
        -
        - -

        talentGrid

        - - -
        -
        -

        Information about the talent grid attached to the item. Talent nodes can provide - a variety of benefits and abilities, and in Destiny 2 are used almost - exclusively for the character's "Builds".

        -
        -

        COMPONENT TYPE: ItemTalentGrids

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemsackblockdefinition.html b/docs/interfaces/idestinyitemsackblockdefinition.html deleted file mode 100644 index c8851b1..0000000 --- a/docs/interfaces/idestinyitemsackblockdefinition.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - IDestinyItemSackBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemSackBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Some items are "sacks" - they can be "opened" to produce other items. This is - information related to its sack status, mostly UI strings. Engrams are an - example of items that are considered to be "Sacks".

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemSackBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        detailAction

        -
        detailAction: string
        - -
        -
        -

        A description of what will happen when you open the sack. As far as I can tell, - this is blank currently. Unknown whether it will eventually be populated with - useful info.

        -
        -
        -
        -
        - -

        openAction

        -
        openAction: string
        - -
        -
        -

        The localized name of the action being performed when you open the sack.

        -
        -
        -
        -
        - -

        openOnAcquire

        -
        openOnAcquire: boolean
        - -
        -
        - -

        selectItemCount

        -
        selectItemCount: number
        - -
        -
        - -

        vendorSackType

        -
        vendorSackType: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemsetactionrequest.html b/docs/interfaces/idestinyitemsetactionrequest.html deleted file mode 100644 index 67228f7..0000000 --- a/docs/interfaces/idestinyitemsetactionrequest.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IDestinyItemSetActionRequest | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemSetActionRequest

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemSetActionRequest -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        characterId

        -
        characterId: string
        - -
        -
        - -

        itemIds

        -
        itemIds: string[]
        - -
        -
        - -

        membershipType

        -
        membershipType: BungieMembershipType
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemsetblockdefinition.html b/docs/interfaces/idestinyitemsetblockdefinition.html deleted file mode 100644 index 0834dcc..0000000 --- a/docs/interfaces/idestinyitemsetblockdefinition.html +++ /dev/null @@ -1,268 +0,0 @@ - - - - - - IDestinyItemSetBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemSetBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Primarily for Quests, this is the definition of properties related to the item - if it is a quest and its various quest steps.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemSetBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        itemList

        - - -
        -
        -

        A collection of hashes of set items, for items such as Quest Metadata items that - possess this data.

        -
        -
        -
        -
        - -

        requireOrderedSetItemAdd

        -
        requireOrderedSetItemAdd: boolean
        - -
        -
        -

        If true, items in the set can only be added in increasing order, and adding an - item will remove any previous item. For Quests, this is by necessity true. Only - one quest step is present at a time, and previous steps are removed as you - advance in the quest.

        -
        -
        -
        -
        - -

        setIsFeatured

        -
        setIsFeatured: boolean
        - -
        -
        -

        If true, the UI should treat this quest as "featured"

        -
        -
        -
        -
        - -

        setType

        -
        setType: string
        - -
        -
        -

        A string identifier we can use to attempt to identify the category of the Quest.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemsetblockentrydefinition.html b/docs/interfaces/idestinyitemsetblockentrydefinition.html deleted file mode 100644 index 67feb54..0000000 --- a/docs/interfaces/idestinyitemsetblockentrydefinition.html +++ /dev/null @@ -1,230 +0,0 @@ - - - - - - IDestinyItemSetBlockEntryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemSetBlockEntryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Defines a particular entry in an ItemSet (AKA a particular Quest Step in a Quest)

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemSetBlockEntryDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        itemHash

        -
        itemHash: number
        - -
        -
        -

        This is the hash identifier for a DestinyInventoryItemDefinition representing - this quest step.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        trackingValue

        -
        trackingValue: number
        - -
        -
        -

        Used for tracking which step a user reached. These values will be populated in - the user's internal state, which we expose externally as a more usable - DestinyQuestStatus object. If this item has been obtained, this value will be - set in trackingUnlockValueHash.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemsocketblockdefinition.html b/docs/interfaces/idestinyitemsocketblockdefinition.html deleted file mode 100644 index e3693ca..0000000 --- a/docs/interfaces/idestinyitemsocketblockdefinition.html +++ /dev/null @@ -1,270 +0,0 @@ - - - - - - IDestinyItemSocketBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemSocketBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If defined, the item has at least one socket.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemSocketBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        detail

        -
        detail: string
        - -
        -
        -

        This was supposed to be a string that would give per-item details about sockets. - In practice, it turns out that all this ever has is the localized word "details". - ... that's lame, but perhaps it will become something cool in the future.

        -
        -
        -
        -
        - -

        intrinsicSockets

        - - -
        -
        -

        Each intrinsic (or immutable/permanent) socket on an item is defined here, along - with the plug that is permanently affixed to the socket.

        -
        -
        -
        -
        - -

        socketCategories

        - - -
        -
        -

        A convenience property, that refers to the sockets in the "sockets" property, - pre-grouped by category and ordered in the manner that they should be grouped in - the UI. You could form this yourself with the existing data, but why would you - want to? Enjoy life man.

        -
        -
        -
        -
        - -

        socketEntries

        - - -
        -
        -

        Each non-intrinsic (or mutable) socket on an item is defined here. Check inside - for more info.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemsocketcategorydefinition.html b/docs/interfaces/idestinyitemsocketcategorydefinition.html deleted file mode 100644 index 389923d..0000000 --- a/docs/interfaces/idestinyitemsocketcategorydefinition.html +++ /dev/null @@ -1,231 +0,0 @@ - - - - - - IDestinyItemSocketCategoryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemSocketCategoryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Sockets are grouped into categories in the UI. These define which category and - which sockets are under that category.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemSocketCategoryDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        socketCategoryHash

        -
        socketCategoryHash: number
        - -
        -
        -

        The hash for the Socket Category: a quick way to go get the header display - information for the category. Use it to look up DestinySocketCategoryDefinition - info.

        -
        -

        Mapped to IDestinySocketCategoryDefinition in the manifest.

        -
        -
        -
        - -

        socketIndexes

        -
        socketIndexes: number[]
        - -
        -
        -

        Use these indexes to look up the sockets in the "sockets.socketEntries" property - on the item definition. These are the indexes under the category, in game- - rendered order.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemsocketentrydefinition.html b/docs/interfaces/idestinyitemsocketentrydefinition.html deleted file mode 100644 index 47f595a..0000000 --- a/docs/interfaces/idestinyitemsocketentrydefinition.html +++ /dev/null @@ -1,388 +0,0 @@ - - - - - - IDestinyItemSocketEntryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemSocketEntryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The definition information for a specific socket on an item. This will determine - how the socket behaves in-game.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemSocketEntryDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        defaultVisible

        -
        defaultVisible: boolean
        - -
        -
        -

        If true, then this socket is visible in the item's "default" state. If you have - an instance, you should always check the runtime state, as that can override - this visibility setting: but if you're looking at the item on a conceptual level, - this property can be useful for hiding data such as legacy sockets - which - remain defined on items for infrastructure purposes, but can be confusing for - users to see.

        -
        -
        -
        -
        - -

        hidePerksInItemTooltip

        -
        hidePerksInItemTooltip: boolean
        - -
        -
        -

        If this is true, the perks provided by this socket shouldn't be shown in the - item's tooltip. This might be useful if it's providing a hidden bonus, or if the - bonus is less important than other benefits on the item.

        -
        -
        -
        -
        - -

        plugSources

        -
        plugSources: SocketPlugSources
        - -
        -
        -

        Indicates where you should go to get plugs for this socket. This will affect how - you populate your UI, as well as what plugs are valid for this socket. It's an - alternative to having to check for the existence of certain properties ( - reusablePlugItems for example) to infer where plugs should come from.

        -
        -
        -
        -
        - -

        preventInitializationOnVendorPurchase

        -
        preventInitializationOnVendorPurchase: boolean
        - -
        -
        -

        If this is true, then the socket will not be initialized with a plug if the item - is purchased from a Vendor.

        -
        -

        Remember that Vendors are much more than conceptual vendors: they include " - Collection Kiosks" and other entities. See DestinyVendorDefinition for more - information.

        -
        -
        -
        - -

        randomizedPlugItems

        - - -
        -
        -

        As of Forsaken, item sockets can have randomized plugs. If this is populated, - the live data will return a subset of plugs from this list that are active and - able to be inserted into the socket just like a reusable plug.

        -
        -
        -
        -
        - -

        reusablePlugItems

        - - -
        -
        -

        This is a list of pre-determined plugs that can always be plugged into this - socket, without the character having the plug in their inventory.

        -
        -

        If this list is populated, you will not be allowed to plug an arbitrary item in - the socket: you will only be able to choose from one of these reusable plugs.

        -
        -
        -
        - -

        Optional reusablePlugSetHash

        -
        reusablePlugSetHash: number
        - -
        -
        -

        If this socket's plugs come from a reusable DestinyPlugSetDefinition, this is - the identifier for that set. We added this concept to reduce some major - duplication that's going to come from sockets as replacements for what was once - implemented as large sets of items and kiosks (like Emotes).

        -
        -
        -
        -
        - -

        singleInitialItemHash

        -
        singleInitialItemHash: number
        - -
        -
        -

        If a valid hash, this is the hash identifier for the - DestinyInventoryItemDefinition representing the Plug that will be initially - inserted into the item on item creation. Otherwise, this Socket will either - start without a plug inserted, or will have one randomly inserted.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        socketTypeHash

        -
        socketTypeHash: number
        - -
        -
        -

        All sockets have a type, and this is the hash identifier for this particular - type. Use it to look up the DestinySocketTypeDefinition: read there for more - information on how socket types affect the behavior of the socket.

        -
        -

        Mapped to IDestinySocketTypeDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemsocketentryplugitemdefinition.html b/docs/interfaces/idestinyitemsocketentryplugitemdefinition.html deleted file mode 100644 index 02942be..0000000 --- a/docs/interfaces/idestinyitemsocketentryplugitemdefinition.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IDestinyItemSocketEntryPlugItemDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemSocketEntryPlugItemDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The definition of a known, reusable plug that can be applied to a socket.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemSocketEntryPlugItemDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        plugItemHash

        -
        plugItemHash: number
        - -
        -
        -

        The hash identifier of a DestinyInventoryItemDefinition representing the plug - that can be inserted.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemsocketentryplugitemrandomizeddefinition.html b/docs/interfaces/idestinyitemsocketentryplugitemrandomizeddefinition.html deleted file mode 100644 index 6869697..0000000 --- a/docs/interfaces/idestinyitemsocketentryplugitemrandomizeddefinition.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - - IDestinyItemSocketEntryPlugItemRandomizedDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemSocketEntryPlugItemRandomizedDefinition

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemSocketEntryPlugItemRandomizedDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        plugItemHash

        -
        plugItemHash: number
        - -
        -
        -

        The hash identifier of a DestinyInventoryItemDefinition representing the plug - that can be inserted.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemsocketscomponent.html b/docs/interfaces/idestinyitemsocketscomponent.html deleted file mode 100644 index 52aa0e4..0000000 --- a/docs/interfaces/idestinyitemsocketscomponent.html +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - IDestinyItemSocketsComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemSocketsComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Instanced items can have sockets, which are slots on the item where plugs can be - inserted.

        -
        -

        Sockets are a bit complex: be sure to examine the documentation on the - DestinyInventoryItemDefinition's "socket" block and elsewhere on these objects - for more details.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemSocketsComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        sockets

        - - -
        -
        -

        The list of all sockets on the item, and their status information.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemsocketstate.html b/docs/interfaces/idestinyitemsocketstate.html deleted file mode 100644 index 2934854..0000000 --- a/docs/interfaces/idestinyitemsocketstate.html +++ /dev/null @@ -1,356 +0,0 @@ - - - - - - IDestinyItemSocketState | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemSocketState

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The status of a given item's socket. (which plug is inserted, if any: whether it - is enabled, what "reusable" plugs can be inserted, etc...)

        -
        -

        If I had it to do over, this would probably have a DestinyItemPlug representing - the inserted item instead of most of these properties. :shrug:

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemSocketState -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        enableFailIndexes

        -
        enableFailIndexes: number[]
        - -
        -
        -

        If a plug is inserted but not enabled, this will be populated with indexes into - the plug item definition's plug.enabledRules property, so that you can show the - reasons why it is not enabled.

        -
        -
        -
        -
        - -

        isEnabled

        -
        isEnabled: boolean
        - -
        -
        -

        Even if a plug is inserted, it doesn't mean it's enabled.

        -
        -

        This flag indicates whether the plug is active and providing its benefits.

        -
        -
        -
        - -

        isVisible

        -
        isVisible: boolean
        - -
        -
        -

        A plug may theoretically provide benefits but not be visible - for instance, - some older items use a plug's damage type perk to modify their own damage type. - These, though they are not visible, still affect the item. This field indicates - that state.

        -
        -

        An invisible plug, while it provides benefits if it is Enabled, cannot be - directly modified by the user.

        -
        -
        -
        - -

        Optional plugHash

        -
        plugHash: number
        - -
        -
        -

        The currently active plug, if any.

        -
        -

        Note that, because all plugs are statically defined, its effect on stats and - perks can be statically determined using the plug item's definition. The stats - and perks can be taken at face value on the plug item as the stats and perks it - will provide to the user/item.

        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        plugObjectives

        -
        plugObjectives: IDestinyObjectiveProgress[]
        - -
        -
        -

        Sometimes, Plugs may have objectives: generally, these are used for flavor and - display purposes. For instance, a Plug might be tracking the number of PVP kills - you have made. It will use the parent item's data about that tracking status to - determine what to show, and will generally show it using the - DestinyObjectiveDefinition's progressDescription property. Refer to the plug's - itemHash and objective property for more information if you would like to - display even more data.

        -
        -
        -
        -
        - -

        reusablePlugHashes

        -
        reusablePlugHashes: number[]
        - -
        -
        -

        If the item supports reusable plugs, this is the list of plug item hashes that - are currently allowed to be used for this socket. See the "reusablePlugs" - property, which has rendered this obsolete, for more information.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        reusablePlugs

        -
        reusablePlugs: IDestinyItemPlug[]
        - -
        -
        -

        If the item supports reusable plugs, this is the list of plugs that are allowed - to be used for the socket, and any relevant information about whether they are " - enabled", whether they are allowed to be inserted, and any other information - such as objectives.

        -
        -

        A Reusable Plug is a plug that you can always insert into this socket as long as - its insertion rules are passed, regardless of whether or not you have the plug - in your inventory. An example of it failing an insertion rule would be if it has - an Objective that needs to be completed before it can be inserted, and that - objective hasn't been completed yet.

        -

        In practice, a socket will either have reusable plugs or it will allow for - plugs in your inventory to be inserted. See DestinyInventoryItemDefinition. - socket for more info.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemsourceblockdefinition.html b/docs/interfaces/idestinyitemsourceblockdefinition.html deleted file mode 100644 index 4843911..0000000 --- a/docs/interfaces/idestinyitemsourceblockdefinition.html +++ /dev/null @@ -1,248 +0,0 @@ - - - - - - IDestinyItemSourceBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemSourceBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Data about an item's "sources": ways that the item can be obtained.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemSourceBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        exclusive

        - - -
        -
        -

        If we found that this item is exclusive to a specific platform, this will be set - to the BungieMembershipType enumeration that matches that platform.

        -
        -
        -
        -
        - -

        sourceHashes

        -
        sourceHashes: number[]
        - -
        -
        -

        The list of hash identifiers for Reward Sources that hint where the item can be - found (DestinyRewardSourceDefinition).

        -
        -

        Mapped to IDestinyRewardSourceDefinition in the manifest.

        -
        -
        -
        - -

        sources

        - - -
        -
        -

        A collection of details about the stats that were computed for the ways we found - that the item could be spawned.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemsourcedefinition.html b/docs/interfaces/idestinyitemsourcedefinition.html deleted file mode 100644 index d46d02c..0000000 --- a/docs/interfaces/idestinyitemsourcedefinition.html +++ /dev/null @@ -1,342 +0,0 @@ - - - - - - IDestinyItemSourceDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemSourceDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Properties of a DestinyInventoryItemDefinition that store all of the information - we were able to discern about how the item spawns, and where you can find the - item.

        -
        -

        Items will have many of these sources, one per level at which it spawns, to try - and give more granular data about where items spawn for specific level ranges.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemSourceDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        computedStats

        -
        computedStats: object
        - -
        -
        -

        The stats computed for this level/quality range.

        -
        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        level

        -
        level: number
        - -
        -
        -

        The level at which the item spawns. Essentially the Primary Key for this source - data: there will be multiple of these source entries per item that has source - data, grouped by the level at which the item spawns.

        -
        -
        -
        -
        - -

        maxLevelRequired

        -
        maxLevelRequired: number
        - -
        -
        -

        The maximum Character Level required for equipping the item when the item spawns - at the item level defined on this DestinyItemSourceDefinition, as far as we saw - in our processing.

        -
        -
        -
        -
        - -

        maxQuality

        -
        maxQuality: number
        - -
        -
        -

        The maximum quality at which the item spawns for this level.

        -
        -
        -
        -
        - -

        minLevelRequired

        -
        minLevelRequired: number
        - -
        -
        -

        The minimum Character Level required for equipping the item when the item spawns - at the item level defined on this DestinyItemSourceDefinition, as far as we saw - in our processing.

        -
        -
        -
        -
        - -

        minQuality

        -
        minQuality: number
        - -
        -
        -

        The minimum Quality at which the item spawns for this level. Examine - DestinyInventoryItemDefinition for more information about what Quality means. - Just don't ask Phaedrus about it, he'll never stop talking and you'll have to - write a book about it.

        -
        -
        -
        -
        - -

        sourceHashes

        -
        sourceHashes: number[]
        - -
        -
        -

        The DestinyRewardSourceDefinitions found that can spawn the item at this level.

        -
        -

        Mapped to IDestinyRewardSourceDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemstatblockdefinition.html b/docs/interfaces/idestinyitemstatblockdefinition.html deleted file mode 100644 index aa31d95..0000000 --- a/docs/interfaces/idestinyitemstatblockdefinition.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - IDestinyItemStatBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemStatBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Information about the item's calculated stats, with as much data as we can find - for the stats without having an actual instance of the item.

        -
        -

        Note that this means the entire concept of providing these stats is - fundamentally insufficient: we cannot predict with 100% accuracy the conditions - under which an item can spawn, so we use various heuristics to attempt to - simulate the conditions as accurately as possible. Actual stats for items in- - game can and will vary, but these should at least be useful base points for - comparison and display.

        -

        It is also worth noting that some stats, like Magazine size, have further - calculations performed on them by scripts in-game and on the game servers that - BNet does not have access to. We cannot know how those stats are further - transformed, and thus some stats will be inaccurate even on instances of items - in BNet vs. how they appear in-game. This is a known limitation of our item - statistics, without any planned fix.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemStatBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        disablePrimaryStatDisplay

        -
        disablePrimaryStatDisplay: boolean
        - -
        -
        -

        If true, the game won't show the "primary" stat on this item when you inspect it.

        -
        -

        NOTE: This is being manually mapped, because I happen to want it in a block that - isn't going to directly create this derivative block.

        -
        -
        -
        - -

        hasDisplayableStats

        -
        hasDisplayableStats: boolean
        - -
        -
        -

        A quick and lazy way to determine whether any stat other than the "primary" stat - is actually visible on the item. Items often have stats that we return in case - people find them useful, but they're not part of the "Stat Group" and thus we - wouldn't display them in our UI. If this is False, then we're not going to - display any of these stats other than the primary one.

        -
        -
        -
        -
        - -

        primaryBaseStatHash

        -
        primaryBaseStatHash: number
        - -
        -
        -

        This stat is determined to be the "primary" stat, and can be looked up in the - stats or any other stat collection related to the item.

        -
        -

        Use this hash to look up the stat's value using DestinyInventoryItemDefinition. - stats.stats, and the renderable data for the primary stat in the related - DestinyStatDefinition.

        -

        Mapped to IDestinyStatDefinition in the manifest.

        -
        -
        -
        - -

        Optional statGroupHash

        -
        statGroupHash: number
        - -
        -
        -

        If the item's stats are meant to be modified by a DestinyStatGroupDefinition, - this will be the identifier for that definition.

        -
        -

        If you are using live data or precomputed stats data on the - DestinyInventoryItemDefinition.stats.stats property, you don't have to worry - about statGroupHash and how it alters stats: the already altered stats are - provided to you. But if you want to see how the sausage gets made, or perform - computations yourself, this is valuable information.

        -

        Mapped to IDestinyStatGroupDefinition in the manifest.

        -
        -
        -
        - -

        stats

        -
        stats: object
        - -
        -
        -

        If you are looking for precomputed values for the stats on a weapon, this is - where they are stored. Technically these are the "Display" stat values. Please - see DestinyStatsDefinition for what Display Stat Values means, it's a very long - story... but essentially these are the closest values BNet can get to the item - stats that you see in-game.

        -
        -

        These stats are keyed by the DestinyStatDefinition's hash identifier for the - stat that's found on the item.

        -

        Mapped to IDestinyStatDefinition in the manifest.

        -
        -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemstaterequest.html b/docs/interfaces/idestinyitemstaterequest.html deleted file mode 100644 index cff3983..0000000 --- a/docs/interfaces/idestinyitemstaterequest.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - IDestinyItemStateRequest | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemStateRequest

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemStateRequest -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        characterId

        -
        characterId: string
        - -
        -
        - -

        itemId

        -
        itemId: string
        - -
        -
        - -

        membershipType

        -
        membershipType: BungieMembershipType
        - -
        -
        - -

        state

        -
        state: boolean
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemstatscomponent.html b/docs/interfaces/idestinyitemstatscomponent.html deleted file mode 100644 index 36a253f..0000000 --- a/docs/interfaces/idestinyitemstatscomponent.html +++ /dev/null @@ -1,220 +0,0 @@ - - - - - - IDestinyItemStatsComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemStatsComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If you want the stats on an item's instanced data, get this component.

        -
        -

        These are stats like Attack, Defense etc... and not historical stats.

        -

        Note that some stats have additional computation in-game at runtime - for - instance, Magazine Size - and thus these stats might not be 100% accurate - compared to what you see in-game for some stats. I know, it sucks. I hate it too.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemStatsComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        stats

        -
        stats: object
        - -
        -
        -

        If the item has stats that it provides (damage, defense, etc...), it will be - given here.

        -
        -

        Mapped to IDestinyStatDefinition in the manifest.

        -
        -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemsummaryblockdefinition.html b/docs/interfaces/idestinyitemsummaryblockdefinition.html deleted file mode 100644 index 3febb76..0000000 --- a/docs/interfaces/idestinyitemsummaryblockdefinition.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IDestinyItemSummaryBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemSummaryBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This appears to be information used when rendering rewards. We don't currently - use it on BNet.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemSummaryBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        sortPriority

        -
        sortPriority: number
        - -
        -
        -

        Apparently when rendering an item in a reward, this should be used as a sort - priority. We're not doing it presently.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemtalentgridblockdefinition.html b/docs/interfaces/idestinyitemtalentgridblockdefinition.html deleted file mode 100644 index cd6baff..0000000 --- a/docs/interfaces/idestinyitemtalentgridblockdefinition.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - IDestinyItemTalentGridBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemTalentGridBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This defines information that can only come from a talent grid on an item. Items - mostly have negligible talent grid data these days, but instanced items still - retain grids as a source for some of this common information.

        -
        -

        Builds/Subclasses are the only items left that still have talent grids with - meaningful Nodes.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemTalentGridBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        buildName

        -
        buildName: string
        - -
        -
        -

        A shortcut string identifier for the "build" in question, if this talent grid - has an associated build. Doesn't map to anything we can expose at the moment.

        -
        -
        -
        -
        - -

        hudDamageType

        -
        hudDamageType: DamageType
        - -
        -
        -

        If the talent grid implies a damage type, this is the enum value for that damage - type.

        -
        -
        -
        -
        - -

        hudIcon

        -
        hudIcon: string
        - -
        -
        -

        If the talent grid has a special icon that's shown in the game UI (like builds, - funny that), this is the identifier for that icon. Sadly, we don't actually get - that icon right now. I'll be looking to replace this with a path to the actual - icon itself.

        -
        -
        -
        -
        - -

        itemDetailString

        -
        itemDetailString: string
        - -
        -
        -

        This is meant to be a subtitle for looking at the talent grid. In practice, - somewhat frustratingly, this always merely says the localized word for "Details". - Great. Maybe it'll have more if talent grids ever get used for more than builds - and subclasses again.

        -
        -
        -
        -
        - -

        talentGridHash

        -
        talentGridHash: number
        - -
        -
        -

        The hash identifier of the DestinyTalentGridDefinition attached to this item.

        -
        -

        Mapped to IDestinyTalentGridDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemtalentgridcomponent.html b/docs/interfaces/idestinyitemtalentgridcomponent.html deleted file mode 100644 index f9af520..0000000 --- a/docs/interfaces/idestinyitemtalentgridcomponent.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - IDestinyItemTalentGridComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemTalentGridComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Well, we're here in Destiny 2, and Talent Grids are unfortunately still around.

        -
        -

        The good news is that they're pretty much only being used for certain base - information on items and for Builds/Subclasses. The bad news is that they still - suck. If you really want this information, grab this component.

        -

        An important note is that talent grids are defined as such:

        -

        A Grid has 1:M Nodes, which has 1:M Steps.

        -

        Any given node can only have a single step active at one time, which represents - the actual visual contents and effects of the Node (for instance, if you see a " - Super Cool Bonus" node, the actual icon and text for the node is coming from the - current Step of that node).

        -

        Nodes can be grouped into exclusivity sets and as of D2, exclusivity groups ( - which are collections of exclusivity sets that affect each other).

        -

        See DestinyTalentGridDefinition for more information. Brace yourself, the water' - s cold out there in the deep end.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemTalentGridComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        gridProgression

        -
        gridProgression: IDestinyProgression
        - -
        -
        -

        If the item has a progression, it will be detailed here. A progression means - that the item can gain experience. Thresholds of experience are what determines - whether and when a talent node can be activated.

        -
        -
        -
        -
        - -

        isGridComplete

        -
        isGridComplete: boolean
        - -
        -
        -

        Indicates whether the talent grid on this item is completed, and thus whether it - should have a gold border around it.

        -
        -

        Only will be true if the item actually has a talent grid, and only then if it - is completed (i.e. every exclusive set has an activated node, and every non- - exclusive set node has been activated)

        -
        -
        -
        - -

        nodes

        - - -
        -
        -

        Detailed information about the individual nodes in the talent grid.

        -
        -

        A node represents a single visual "pip" in the talent grid or Build detail view, - though each node may have multiple "steps" which indicate the actual bonuses and - visual representation of that node.

        -
        -
        -
        - -

        talentGridHash

        -
        talentGridHash: number
        - -
        -
        -

        Most items don't have useful talent grids anymore, but Builds in particular - still do.

        -
        -

        You can use this hash to lookup the DestinyTalentGridDefinition attached to this - item, which will be crucial for understanding the node values on the item.

        -

        Mapped to IDestinyTalentGridDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemtiertypedefinition.html b/docs/interfaces/idestinyitemtiertypedefinition.html deleted file mode 100644 index 7a9fe70..0000000 --- a/docs/interfaces/idestinyitemtiertypedefinition.html +++ /dev/null @@ -1,283 +0,0 @@ - - - - - - IDestinyItemTierTypeDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemTierTypeDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Defines the tier type of an item. Mostly this provides human readable properties - for types like Common, Rare, etc...

        -
        -

        It also provides some base data for infusion that could be useful.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemTierTypeDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        infusionProcess

        - - -
        -
        -

        If this tier defines infusion properties, they will be contained here.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemtiertypeinfusionblock.html b/docs/interfaces/idestinyitemtiertypeinfusionblock.html deleted file mode 100644 index 125e6db..0000000 --- a/docs/interfaces/idestinyitemtiertypeinfusionblock.html +++ /dev/null @@ -1,225 +0,0 @@ - - - - - - IDestinyItemTierTypeInfusionBlock | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemTierTypeInfusionBlock

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemTierTypeInfusionBlock -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        baseQualityTransferRatio

        -
        baseQualityTransferRatio: number
        - -
        -
        -

        The default portion of quality that will transfer from the infuser to the - infusee item. (InfuserQuality - InfuseeQuality) * baseQualityTransferRatio = - base quality transferred.

        -
        -
        -
        -
        - -

        minimumQualityIncrement

        -
        minimumQualityIncrement: number
        - -
        -
        -

        As long as InfuserQuality > InfuseeQuality, the amount of quality bestowed is - guaranteed to be at least this value, even if the transferRatio would dictate - that it should be less. The total amount of quality that ends up in the Infusee - cannot exceed the Infuser's quality however (for instance, if you infuse a 300 - item with a 301 item and the minimum quality increment is 10, the infused item - will not end up with 310 quality)

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemtransferrequest.html b/docs/interfaces/idestinyitemtransferrequest.html deleted file mode 100644 index ea14c0f..0000000 --- a/docs/interfaces/idestinyitemtransferrequest.html +++ /dev/null @@ -1,264 +0,0 @@ - - - - - - IDestinyItemTransferRequest | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemTransferRequest

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemTransferRequest -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        characterId

        -
        characterId: string
        - -
        -
        - -

        itemId

        -
        itemId: string
        - -
        -
        - -

        itemReferenceHash

        -
        itemReferenceHash: number
        - -
        -
        - -

        membershipType

        -
        membershipType: BungieMembershipType
        - -
        -
        - -

        stackSize

        -
        stackSize: number
        - -
        -
        - -

        transferToVault

        -
        transferToVault: boolean
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemtranslationblockdefinition.html b/docs/interfaces/idestinyitemtranslationblockdefinition.html deleted file mode 100644 index 2b5a774..0000000 --- a/docs/interfaces/idestinyitemtranslationblockdefinition.html +++ /dev/null @@ -1,285 +0,0 @@ - - - - - - IDestinyItemTranslationBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemTranslationBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This Block defines the rendering data associated with the item, if any.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemTranslationBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        arrangements

        - - -
        -
        - -

        customDyes

        -
        customDyes: IDyeReference[]
        - -
        -
        - -

        defaultDyes

        -
        defaultDyes: IDyeReference[]
        - -
        -
        - -

        hasGeometry

        -
        hasGeometry: boolean
        - -
        -
        - -

        lockedDyes

        -
        lockedDyes: IDyeReference[]
        - -
        -
        - -

        weaponPatternHash

        -
        weaponPatternHash: number
        - -
        -
        - -

        weaponPatternIdentifier

        -
        weaponPatternIdentifier: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyitemvalueblockdefinition.html b/docs/interfaces/idestinyitemvalueblockdefinition.html deleted file mode 100644 index ed38140..0000000 --- a/docs/interfaces/idestinyitemvalueblockdefinition.html +++ /dev/null @@ -1,235 +0,0 @@ - - - - - - IDestinyItemValueBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyItemValueBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This defines an item's "Value". Unfortunately, this appears to be used in - different ways depending on the way that the item itself is used.

        -
        -

        For items being sold at a Vendor, this is the default "sale price" of the item. - These days, the vendor itself almost always sets the price, but it still - possible for the price to fall back to this value. For quests, it is a preview - of rewards you can gain by completing the quest. For dummy items, if the - itemValue refers to an Emblem, it is the emblem that should be shown as the - reward. (jeez louise)

        -

        It will likely be used in a number of other ways in the future, it appears to be - a bucket where they put arbitrary items and quantities into the item.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyItemValueBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        itemValue

        - - -
        -
        -

        References to the items that make up this item's "value", and the quantity.

        -
        -
        -
        -
        - -

        valueDescription

        -
        valueDescription: string
        - -
        -
        -

        If there's a localized text description of the value provided, this will be said - description.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinykioskitem.html b/docs/interfaces/idestinykioskitem.html deleted file mode 100644 index dc54084..0000000 --- a/docs/interfaces/idestinykioskitem.html +++ /dev/null @@ -1,262 +0,0 @@ - - - - - - IDestinyKioskItem | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyKioskItem

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyKioskItem -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        canAcquire

        -
        canAcquire: boolean
        - -
        -
        -

        If true, the user can not only see the item, but they can acquire it. It is - possible that a user can see a kiosk item and not be able to acquire it.

        -
        -
        -
        -
        - -

        failureIndexes

        -
        failureIndexes: number[]
        - -
        -
        -

        Indexes into failureStrings for the Vendor, indicating the reasons why it failed - if any.

        -
        -
        -
        -
        - -

        flavorObjective

        -
        flavorObjective: IDestinyObjectiveProgress
        - -
        -
        -

        I may regret naming it this way - but this represents when an item has an - objective that doesn't serve a beneficial purpose, but rather is used for " - flavor" or additional information. For instance, when Emblems track specific - stats, those stats are represented as Objectives on the item.

        -
        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the item in the related DestinyVendorDefintion's itemList property, - representing the sale.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinykioskscomponent.html b/docs/interfaces/idestinykioskscomponent.html deleted file mode 100644 index 82be548..0000000 --- a/docs/interfaces/idestinykioskscomponent.html +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - IDestinyKiosksComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyKiosksComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A Kiosk is a Vendor (DestinyVendorDefinition) that sells items based on whether - you have already acquired that item before.

        -
        -

        This component returns information about what Kiosk items are available to you - on a Profile level. It is theoretically possible for Kiosks to have items - gated by specific Character as well. If you ever have those, you will find them - on the individual character's DestinyCharacterKiosksComponent.

        -

        Note that, because this component returns vendorItemIndexes (that is to say, - indexes into the Kiosk Vendor's itemList property), these results are - necessarily content version dependent. Make sure that you have the latest - version of the content manifest databases before using this data.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyKiosksComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        kioskItems

        -
        kioskItems: object
        - -
        -
        -

        A dictionary keyed by the Kiosk Vendor's hash identifier (use it to look up the - DestinyVendorDefinition for the relevant kiosk vendor), and whose value is a - list of all the items that the user can "see" in the Kiosk, and any other - interesting metadata.

        -
        -

        Mapped to IDestinyVendorDefinition in the manifest.

        -
        -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyleaderboard.html b/docs/interfaces/idestinyleaderboard.html deleted file mode 100644 index 36bdef5..0000000 --- a/docs/interfaces/idestinyleaderboard.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IDestinyLeaderboard | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyLeaderboard

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyLeaderboard -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        entries

        - - -
        -
        - -

        statId

        -
        statId: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyleaderboardentry.html b/docs/interfaces/idestinyleaderboardentry.html deleted file mode 100644 index 1c0c577..0000000 --- a/docs/interfaces/idestinyleaderboardentry.html +++ /dev/null @@ -1,256 +0,0 @@ - - - - - - IDestinyLeaderboardEntry | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyLeaderboardEntry

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyLeaderboardEntry -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        characterId

        -
        characterId: string
        - -
        -
        -

        ID of the player's best character for the reported stat.

        -
        -
        -
        -
        - -

        player

        - - -
        -
        -

        Identity details of the player

        -
        -
        -
        -
        - -

        rank

        -
        rank: number
        - -
        -
        -

        Where this player ranks on the leaderboard. A value of 1 is the top rank.

        -
        -
        -
        -
        - -

        value

        - - -
        -
        -

        Value of the stat for this player

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinylinkedgraphdefinition.html b/docs/interfaces/idestinylinkedgraphdefinition.html deleted file mode 100644 index 493c963..0000000 --- a/docs/interfaces/idestinylinkedgraphdefinition.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - - IDestinyLinkedGraphDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyLinkedGraphDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This describes links between the current graph and others, as well as when that - link is relevant.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyLinkedGraphDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        description

        -
        description: string
        - -
        -
        - -

        linkedGraphId

        -
        linkedGraphId: number
        - -
        -
        - -

        linkedGraphs

        - - -
        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        overview

        -
        overview: string
        - -
        -
        - -

        unlockExpression

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinylinkedgraphentrydefinition.html b/docs/interfaces/idestinylinkedgraphentrydefinition.html deleted file mode 100644 index 692242e..0000000 --- a/docs/interfaces/idestinylinkedgraphentrydefinition.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - IDestinyLinkedGraphEntryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyLinkedGraphEntryDefinition

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyLinkedGraphEntryDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activityGraphHash

        -
        activityGraphHash: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinylinkedprofilesresponse.html b/docs/interfaces/idestinylinkedprofilesresponse.html deleted file mode 100644 index c7f0b19..0000000 --- a/docs/interfaces/idestinylinkedprofilesresponse.html +++ /dev/null @@ -1,256 +0,0 @@ - - - - - - IDestinyLinkedProfilesResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyLinkedProfilesResponse

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        I know what you seek. You seek linked accounts. Found them, you have.

        -
        -

        This contract returns a minimal amount of data about Destiny Accounts that are - linked through your Bungie.Net account. We will not return accounts in this - response whose

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyLinkedProfilesResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        bnetMembership

        -
        bnetMembership: IUserInfoCard
        - -
        -
        -

        If the requested membership had a linked Bungie.Net membership ID, this is the - basic information about that BNet account.

        -
        -

        I know, Tetron; I know this is mixing UserServices concerns with DestinyServices - concerns. But it's so damn convenient! https://www.youtube.com/watch?v=X5R-bB- - gKVI

        -
        -
        -
        - -

        profiles

        - - -
        -
        -

        Any Destiny account for whom we could successfully pull characters will be - returned here, as the Platform-level summary of user data. (no character data, - no Destiny account data other than the Membership ID and Type so you can make - further queries)

        -
        -
        -
        -
        - -

        profilesWithErrors

        -
        profilesWithErrors: IDestinyErrorProfile[]
        - -
        -
        -

        This is brief summary info for profiles that we believe have valid Destiny info, - but who failed to return data for some other reason and thus we know that - subsequent calls for their info will also fail.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinylocationdefinition.html b/docs/interfaces/idestinylocationdefinition.html deleted file mode 100644 index 50f7fd3..0000000 --- a/docs/interfaces/idestinylocationdefinition.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - IDestinyLocationDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyLocationDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A "Location" is a sort of shortcut for referring to a specific combination of - Activity, Destination, Place, and even Bubble or NavPoint within a space.

        -
        -

        Most of this data isn't intrinsically useful to us, but Objectives refer to - locations, and through that we can at least infer the Activity, Destination, and - Place being referred to by the Objective.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyLocationDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        locationReleases

        - - -
        -
        -

        A Location may refer to different specific spots in the world based on the world' - s current state. This is a list of those potential spots, and the data we can - use at runtime to determine which one of the spots is the currently valid one.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        vendorHash

        -
        vendorHash: number
        - -
        -
        -

        If the location has a Vendor on it, this is the hash identifier for that Vendor. - Look them up with DestinyVendorDefinition.

        -
        -

        Mapped to IDestinyVendorDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinylocationreleasedefinition.html b/docs/interfaces/idestinylocationreleasedefinition.html deleted file mode 100644 index 5221652..0000000 --- a/docs/interfaces/idestinylocationreleasedefinition.html +++ /dev/null @@ -1,449 +0,0 @@ - - - - - - IDestinyLocationReleaseDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyLocationReleaseDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A specific "spot" referred to by a location. Only one of these can be active at - a time for a given Location.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyLocationReleaseDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activityBubbleName

        -
        activityBubbleName: number
        - -
        -
        -

        The Activity Bubble within the Destination. Look this up in the - DestinyDestinationDefinition's bubbles and bubbleSettings properties.

        -
        -
        -
        -
        - -

        activityGraphHash

        -
        activityGraphHash: number
        - -
        -
        -

        The Activity Graph being pointed to by this location.

        -
        -
        -
        -
        - -

        activityGraphNodeHash

        -
        activityGraphNodeHash: number
        - -
        -
        -

        The Activity Graph Node being pointed to by this location. (Remember that - Activity Graph Node hashes are only unique within an Activity Graph: so use the - combination to find the node being spoken of)

        -
        -
        -
        -
        - -

        activityHash

        -
        activityHash: number
        - -
        -
        -

        The Activity being pointed to by this location.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        activityPathBundle

        -
        activityPathBundle: number
        - -
        -
        -

        If we had map information, this would tell us something cool about the path this - location wants you to take. I wish we had map information.

        -
        -
        -
        -
        - -

        activityPathDestination

        -
        activityPathDestination: number
        - -
        -
        -

        If we had map information, this would tell us about path information related to - destination on the map. Sad. Maybe you can do something cool with it. Go to town - man.

        -
        -
        -
        -
        - -

        destinationHash

        -
        destinationHash: number
        - -
        -
        -

        The Destination being pointed to by this location.

        -
        -

        Mapped to IDestinyDestinationDefinition in the manifest.

        -
        -
        -
        - -

        displayProperties

        - - -
        -
        -

        Sadly, these don't appear to be populated anymore (ever?)

        -
        -
        -
        -
        - -

        largeTransparentIcon

        -
        largeTransparentIcon: string
        - -
        -
        - -

        mapIcon

        -
        mapIcon: string
        - -
        -
        - -

        navPointType

        - - -
        -
        -

        The type of Nav Point that this represents. See the enumeration for more info.

        -
        -
        -
        -
        - -

        smallTransparentIcon

        -
        smallTransparentIcon: string
        - -
        -
        - -

        spawnPoint

        -
        spawnPoint: number
        - -
        -
        -

        If we had map information, this spawnPoint would be interesting. But sadly, we - don't have that info.

        -
        -
        -
        -
        - -

        worldPosition

        -
        worldPosition: number[]
        - -
        -
        -

        Looks like it should be the position on the map, but sadly it does not look - populated... yet?

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyloredefinition.html b/docs/interfaces/idestinyloredefinition.html deleted file mode 100644 index b1990c6..0000000 --- a/docs/interfaces/idestinyloredefinition.html +++ /dev/null @@ -1,280 +0,0 @@ - - - - - - IDestinyLoreDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyLoreDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        These are definitions for in-game "Lore," meant to be narrative enhancements of - the game experience.

        -
        -

        DestinyInventoryItemDefinitions for interesting items point to these definitions, - but nothing's stopping you from scraping all of these and doing something cool - with them. If they end up having cool data.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyLoreDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        subtitle

        -
        subtitle: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymanifest.html b/docs/interfaces/idestinymanifest.html deleted file mode 100644 index 910f537..0000000 --- a/docs/interfaces/idestinymanifest.html +++ /dev/null @@ -1,310 +0,0 @@ - - - - - - IDestinyManifest | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyManifest

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        DestinyManifest is the external-facing contract for just the properties needed - by those calling the Destiny Platform.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyManifest -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        jsonWorldContentPaths

        -
        jsonWorldContentPaths: object
        - -
        -

        Type declaration

        -
          -
        • -
          [key: string]: string
          -
        • -
        -
        -
        -
        - -

        mobileAssetContentPath

        -
        mobileAssetContentPath: string
        - -
        -
        - -

        mobileClanBannerDatabasePath

        -
        mobileClanBannerDatabasePath: string
        - -
        -
        - -

        mobileGearAssetDataBases

        -
        mobileGearAssetDataBases: IGearAssetDataBaseDefinition[]
        - -
        -
        - -

        mobileGearCDN

        -
        mobileGearCDN: object
        - -
        -

        Type declaration

        -
          -
        • -
          [key: string]: string
          -
        • -
        -
        -
        -
        - -

        mobileWorldContentPaths

        -
        mobileWorldContentPaths: object
        - -
        -

        Type declaration

        -
          -
        • -
          [key: string]: string
          -
        • -
        -
        -
        -
        - -

        version

        -
        version: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymaterialrequirement.html b/docs/interfaces/idestinymaterialrequirement.html deleted file mode 100644 index c4190e4..0000000 --- a/docs/interfaces/idestinymaterialrequirement.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - IDestinyMaterialRequirement | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMaterialRequirement

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Many actions relating to items require you to expend materials: - Activating a - talent node - Inserting a plug into a socket The items will refer to material - requirements by a materialRequirementsHash in these cases, and this is the - definition for those requirements in terms of the item required, how much of it - is required and other interesting info. This is one of the rare/strange times - where a single contract class is used both in definitions and in live data - response contracts. I'm not sure yet whether I regret that.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMaterialRequirement -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        count

        -
        count: number
        - -
        -
        -

        The amount of the material required.

        -
        -
        -
        -
        - -

        deleteOnAction

        -
        deleteOnAction: boolean
        - -
        -
        -

        If True, the material will be removed from the character's inventory when the - action is performed.

        -
        -
        -
        -
        - -

        itemHash

        -
        itemHash: number
        - -
        -
        -

        The hash identifier of the material required. Use it to look up the material's - DestinyInventoryItemDefinition.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        omitFromRequirements

        -
        omitFromRequirements: boolean
        - -
        -
        -

        If True, this requirement is "silent": don't bother showing it in a material - requirements display. I mean, I'm not your mom: I'm not going to tell you you * - can't* show it. But we won't show it in our UI.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymaterialrequirementsetdefinition.html b/docs/interfaces/idestinymaterialrequirementsetdefinition.html deleted file mode 100644 index f309631..0000000 --- a/docs/interfaces/idestinymaterialrequirementsetdefinition.html +++ /dev/null @@ -1,270 +0,0 @@ - - - - - - IDestinyMaterialRequirementSetDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMaterialRequirementSetDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represent a set of material requirements: Items that either need to be owned or - need to be consumed in order to perform an action.

        -
        -

        A variety of other entities refer to these as gatekeepers and payments for - actions that can be performed in game.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMaterialRequirementSetDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        materials

        - - -
        -
        -

        The list of all materials that are required.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestone.html b/docs/interfaces/idestinymilestone.html deleted file mode 100644 index 04b0a1e..0000000 --- a/docs/interfaces/idestinymilestone.html +++ /dev/null @@ -1,431 +0,0 @@ - - - - - - IDestinyMilestone | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestone

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents a runtime instance of a user's milestone status. Live Milestone data - should be combined with DestinyMilestoneDefinition data to show the user a - picture of what is available for them to do in the game, and their status in - regards to said "things to do." Consider it a big, wonky to-do list, or Advisors - 3.0 for those who remember the Destiny 1 API.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestone -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activities

        - - -
        -
        -

        The currently active Activities in this milestone, when the Milestone is driven - by Challenges.

        -
        -

        Not all Milestones have Challenges, but when they do this will indicate the - Activities and Challenges under those Activities related to this Milestone.

        -
        -
        -
        - -

        availableQuests

        -
        availableQuests: IDestinyMilestoneQuest[]
        - -
        -
        -

        Indicates what quests are available for this Milestone. Usually this will be - only a single Quest, but some quests have multiple available that you can choose - from at any given time. All possible quests for a milestone can be found in the - DestinyMilestoneDefinition, but they must be combined with this Live data to - determine which one(s) are actually active right now. It is possible for - Milestones to not have any quests.

        -
        -
        -
        -
        - -

        Optional endDate

        -
        endDate: string
        - -
        -
        -

        If known, this is the date when the event will next end or repeat. It will only - be populated for events with fixed and repeating start and end dates.

        -
        -
        -
        -
        - -

        milestoneHash

        -
        milestoneHash: number
        - -
        -
        -

        The unique identifier for the Milestone. Use it to look up the - DestinyMilestoneDefinition, so you can combine the other data in this contract - with static definition data.

        -
        -

        Mapped to IDestinyMilestoneDefinition in the manifest.

        -
        -
        -
        - -

        order

        -
        order: number
        - -
        -
        -

        Used for ordering milestones in a display to match how we order them in BNet. - May pull from static data, or possibly in the future from dynamic information.

        -
        -
        -
        -
        - -

        rewards

        - - -
        -
        -

        If the entity to which this component is attached has known active Rewards for - the player, this will detail information about those rewards, keyed by the - RewardEntry Hash. (See DestinyMilestoneDefinition for more information about - Reward Entries) Note that these rewards are not for the Quests related to the - Milestone. Think of these as "overview/checklist" rewards that may be provided - for Milestones that may provide rewards for performing a variety of tasks that - aren't under a specific Quest.

        -
        -
        -
        -
        - -

        Optional startDate

        -
        startDate: string
        - -
        -
        -

        If known, this is the date when the event last began or refreshed. It will only - be populated for events with fixed and repeating start and end dates.

        -
        -
        -
        -
        - -

        values

        -
        values: object
        - -
        -
        -

        Milestones may have arbitrary key/value pairs associated with them, for data - that users will want to know about but that doesn't fit neatly into any of the - common components such as Quests. A good example of this would be - if this - existed in Destiny 1 - the number of wins you currently have on your Trials of - Osiris ticket. Looking in the DestinyMilestoneDefinition, you can use the string - identifier of this dictionary to look up more info about the value, including - localized string content for displaying the value. The value in the dictionary - is the floating point number. The definition will tell you how to format this - number.

        -
        -
        -
        -

        Type declaration

        -
          -
        • -
          [key: string]: number
          -
        • -
        -
        -
        -
        - -

        vendorHashes

        -
        vendorHashes: number[]
        - -
        -
        -

        A milestone may have one or more active vendors that are "related" to it (that - provide rewards, or that are the initiators of the Milestone). I already regret - this, even as I'm typing it. [I told you I'd regret this] You see, sometimes a - milestone may be directly correlated with a set of vendors that provide varying - tiers of rewards. The player may not be able to interact with one or more of - those vendors. This will return the hashes of the Vendors that the player can - interact with, allowing you to show their current inventory as rewards or - related items to the Milestone or its activities.

        -
        -

        Before we even use it, it's already deprecated! How much of a bummer is that? We - need more data.

        -

        Mapped to IDestinyVendorDefinition in the manifest.

        -
        -
        -
        - -

        vendors

        - - -
        -
        -

        Replaces vendorHashes, which I knew was going to be trouble the day it walked in - the door. This will return not only what Vendors are active and relevant to the - activity (in an implied order that you can choose to ignore), but also other - data - for example, if the Vendor is featuring a specific item relevant to this - event that you should show with them.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestoneactivity.html b/docs/interfaces/idestinymilestoneactivity.html deleted file mode 100644 index ba747ad..0000000 --- a/docs/interfaces/idestinymilestoneactivity.html +++ /dev/null @@ -1,305 +0,0 @@ - - - - - - IDestinyMilestoneActivity | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneActivity

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Sometimes, we know the specific activity that the Milestone wants you to play. - This entity provides additional information about that Activity and all of its - variants. (sometimes there's only one variant, but I think you get the point)

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneActivity -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activityHash

        -
        activityHash: number
        - -
        -
        -

        The hash of an arbitrarily chosen variant of this activity. We'll go ahead and - call that the "canonical" activity, because if you're using this value you - should only use it for properties that are common across the variants: things - like the name of the activity, it's location, etc... Use this hash to look up - the DestinyActivityDefinition of this activity for rendering data.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        Optional activityModeHash

        -
        activityModeHash: number
        - -
        -
        -

        The hash identifier of the most specific Activity Mode under which this activity - is played. This is useful for situations where the activity in question is - for - instance - a PVP map, but it's not clear what mode the PVP map is being played - under. If it's a playlist, this will be less specific: but hopefully useful in - some way.

        -
        -

        Mapped to IDestinyActivityModeDefinition in the manifest.

        -
        -
        -
        - -

        Optional activityModeType

        -
        activityModeType: number
        - -
        -
        -

        The enumeration equivalent of the most specific Activity Mode under which this - activity is played.

        -
        -
        -
        -
        - -

        modifierHashes

        -
        modifierHashes: number[]
        - -
        -
        -

        If the activity has modifiers, this will be the list of modifiers that all - variants have in common. Perform lookups against - DestinyActivityModifierDefinition which defines the modifier being applied to - get at the modifier data. Note that, in the DestiyActivityDefinition, you will - see many more modifiers than this being referred to: those are all possible - modifiers for the activity, not the active ones. Use only the active ones to - match what's really live.

        -
        -

        Mapped to IDestinyActivityModifierDefinition in the manifest.

        -
        -
        -
        - -

        variants

        - - -
        -
        -

        If you want more than just name/location/etc... you're going to have to dig into - and show the variants of the conceptual activity. These will differ in seemingly - arbitrary ways, like difficulty level and modifiers applied. Show it in whatever - way tickles your fancy.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestoneactivitycompletionstatus.html b/docs/interfaces/idestinymilestoneactivitycompletionstatus.html deleted file mode 100644 index 9a8a85a..0000000 --- a/docs/interfaces/idestinymilestoneactivitycompletionstatus.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - - IDestinyMilestoneActivityCompletionStatus | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneActivityCompletionStatus

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents this player's personal completion status for the Activity under a - Milestone, if the activity has trackable completion and progress information. ( - most activities won't, or the concept won't apply. For instance, it makes sense - to talk about a tier of a raid as being Completed or having progress, but it - doesn't make sense to talk about a Crucible Playlist in those terms.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneActivityCompletionStatus -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        completed

        -
        completed: boolean
        - -
        -
        -

        If the activity has been "completed", that information will be returned here.

        -
        -
        -
        -
        - -

        phases

        - - -
        -
        -

        If the Activity has discrete "phases" that we can track, that info will be here. - Otherwise, this value will be NULL. Note that this is a list and not a - dictionary: the order implies the ascending order of phases or progression in - this activity.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestoneactivitydefinition.html b/docs/interfaces/idestinymilestoneactivitydefinition.html deleted file mode 100644 index dcfd062..0000000 --- a/docs/interfaces/idestinymilestoneactivitydefinition.html +++ /dev/null @@ -1,251 +0,0 @@ - - - - - - IDestinyMilestoneActivityDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneActivityDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Milestones can have associated activities which provide additional information - about the context, challenges, modifiers, state etc... related to this Milestone.

        -
        -

        Information we need to be able to return that data is defined here, along with - Tier data to establish a relationship between a conceptual Activity and its - difficulty levels and variants.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneActivityDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        conceptualActivityHash

        -
        conceptualActivityHash: number
        - -
        -
        -

        The "Conceptual" activity hash. Basically, we picked the lowest level activity - and are treating it as the canonical definition of the activity for rendering - purposes.

        -
        -

        If you care about the specific difficulty modes and variations, use the - activities under "Variants".

        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        variants

        -
        variants: object
        - -
        -
        -

        A milestone-referenced activity can have many variants, such as Tiers or - alternative modes of play.

        -
        -

        Even if there is only a single variant, the details for these are represented - within as a variant definition.

        -

        It is assumed that, if this DestinyMilestoneActivityDefinition is active, then - all variants should be active.

        -

        If a Milestone could ever split the variants' active status conditionally, they - should all have their own DestinyMilestoneActivityDefinition instead! The - potential duplication will be worth it for the obviousness of processing and use.

        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestoneactivityphase.html b/docs/interfaces/idestinymilestoneactivityphase.html deleted file mode 100644 index 4264a31..0000000 --- a/docs/interfaces/idestinymilestoneactivityphase.html +++ /dev/null @@ -1,230 +0,0 @@ - - - - - - IDestinyMilestoneActivityPhase | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneActivityPhase

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents whatever information we can return about an explicit phase in an - activity. In the future, I hope we'll have more than just "guh, you done gone - and did something," but for the forseeable future that's all we've got. I'm - making it more than just a list of booleans out of that overly-optimistic hope.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneActivityPhase -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        complete

        -
        complete: boolean
        - -
        -
        -

        Indicates if the phase has been completed.

        -
        -
        -
        -
        - -

        phaseHash

        -
        phaseHash: number
        - -
        -
        -

        In DestinyActivityDefinition, if the activity has phases, there will be a set of - phases defined in the "insertionPoints" property. This is the hash that maps to - that phase.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestoneactivityvariant.html b/docs/interfaces/idestinymilestoneactivityvariant.html deleted file mode 100644 index b226ec4..0000000 --- a/docs/interfaces/idestinymilestoneactivityvariant.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - IDestinyMilestoneActivityVariant | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneActivityVariant

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents custom data that we know about an individual variant of an activity.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneActivityVariant -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activityHash

        -
        activityHash: number
        - -
        -
        -

        The hash for the specific variant of the activity related to this milestone. You - can pull more detailed static info from the DestinyActivityDefinition, such as - difficulty level.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        Optional activityModeHash

        -
        activityModeHash: number
        - -
        -
        -

        The hash identifier of the most specific Activity Mode under which this activity - is played. This is useful for situations where the activity in question is - for - instance - a PVP map, but it's not clear what mode the PVP map is being played - under. If it's a playlist, this will be less specific: but hopefully useful in - some way.

        -
        -

        Mapped to IDestinyActivityModeDefinition in the manifest.

        -
        -
        -
        - -

        Optional activityModeType

        -
        activityModeType: number
        - -
        -
        -

        The enumeration equivalent of the most specific Activity Mode under which this - activity is played.

        -
        -
        -
        -
        - -

        completionStatus

        - - -
        -
        -

        An OPTIONAL component: if it makes sense to talk about this activity variant in - terms of whether or not it has been completed or what progress you have made in - it, this will be returned. Otherwise, this will be NULL.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestoneactivityvariantdefinition.html b/docs/interfaces/idestinymilestoneactivityvariantdefinition.html deleted file mode 100644 index 3d45202..0000000 --- a/docs/interfaces/idestinymilestoneactivityvariantdefinition.html +++ /dev/null @@ -1,235 +0,0 @@ - - - - - - IDestinyMilestoneActivityVariantDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneActivityVariantDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents a variant on an activity for a Milestone: a specific difficulty tier, - or a specific activity variant for example.

        -
        -

        These will often have more specific details, such as an associated Guided Game, - progression steps, tier-specific rewards, and custom values.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneActivityVariantDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activityHash

        -
        activityHash: number
        - -
        -
        -

        The hash to use for looking up the variant Activity's definition ( - DestinyActivityDefinition), where you can find its distinguishing - characteristics such as difficulty level and recommended light level.

        -
        -

        Frequently, that will be the only distinguishing characteristics in practice, - which is somewhat of a bummer.

        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        order

        -
        order: number
        - -
        -
        -

        If you care to do so, render the variants in the order prescribed by this value.

        -
        -

        When you combine live Milestone data with the definition, the order becomes more - useful because you'll be cross-referencing between the definition and live data.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonechallengeactivity.html b/docs/interfaces/idestinymilestonechallengeactivity.html deleted file mode 100644 index e5d2369..0000000 --- a/docs/interfaces/idestinymilestonechallengeactivity.html +++ /dev/null @@ -1,321 +0,0 @@ - - - - - - IDestinyMilestoneChallengeActivity | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneChallengeActivity

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneChallengeActivity -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activityHash

        -
        activityHash: number
        - -
        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        -
        - -

        booleanActivityOptions

        -
        booleanActivityOptions: object
        - -
        -
        -

        The set of activity options for this activity, keyed by an identifier that's - unique for this activity (not guaranteed to be unique between or across all - activities, though should be unique for every variant of a given conceptual - activity: for instance, the original D2 Raid has many variant - DestinyActivityDefinitions. While other activities could potentially have the - same option hashes, for any given D2 base Raid variant the hash will be unique).

        -
        -

        As a concrete example of this data, the hashes you get for Raids will correspond - to the currently active "Challenge Mode".

        -

        We don't have any human readable information for these, but saavy 3rd party app - users could manually associate the key (a hash identifier for the "option" that - is enabled/disabled) and the value (whether it's enabled or disabled presently)

        -

        On our side, we don't necessarily even know what these are used for (the game - designers know, but we don't), and we have no human readable data for them. In - order to use them, you will have to do some experimentation.

        -
        -
        -

        Type declaration

        -
          -
        • -
          [key: number]: boolean
          -
        • -
        -
        -
        -
        - -

        challenges

        - - -
        -
        - -

        Optional loadoutRequirementIndex

        -
        loadoutRequirementIndex: number
        - -
        -
        -

        If returned, this is the index into the DestinyActivityDefinition's "loadouts" - property, indicating the currently active loadout requirements.

        -
        -
        -
        -
        - -

        modifierHashes

        -
        modifierHashes: number[]
        - -
        -
        -

        If the activity has modifiers, this will be the list of modifiers that all - variants have in common. Perform lookups against - DestinyActivityModifierDefinition which defines the modifier being applied to - get at the modifier data.

        -
        -

        Note that, in the DestiyActivityDefinition, you will see many more modifiers - than this being referred to: those are all possible modifiers for the activity, - not the active ones. Use only the active ones to match what's really live.

        -

        Mapped to IDestinyActivityModifierDefinition in the manifest.

        -
        -
        -
        - -

        phases

        - - -
        -
        -

        If the Activity has discrete "phases" that we can track, that info will be here. - Otherwise, this value will be NULL. Note that this is a list and not a - dictionary: the order implies the ascending order of phases or progression in - this activity.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonechallengeactivitydefinition.html b/docs/interfaces/idestinymilestonechallengeactivitydefinition.html deleted file mode 100644 index 367bd5f..0000000 --- a/docs/interfaces/idestinymilestonechallengeactivitydefinition.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - - IDestinyMilestoneChallengeActivityDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneChallengeActivityDefinition

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneChallengeActivityDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activityGraphNodes

        - - -
        -
        -

        If the activity and its challenge is visible on any of these nodes, it will be - returned.

        -
        -
        -
        -
        - -

        activityHash

        -
        activityHash: number
        - -
        -
        -

        The activity for which this challenge is active.

        -
        -
        -
        -
        - -

        challenges

        - - -
        -
        - -

        phases

        - - -
        -
        -

        Phases related to this activity, if there are any.

        -
        -

        These will be listed in the order in which they will appear in the actual - activity.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonechallengeactivitygraphnodeentry.html b/docs/interfaces/idestinymilestonechallengeactivitygraphnodeentry.html deleted file mode 100644 index 6037886..0000000 --- a/docs/interfaces/idestinymilestonechallengeactivitygraphnodeentry.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IDestinyMilestoneChallengeActivityGraphNodeEntry | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneChallengeActivityGraphNodeEntry

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneChallengeActivityGraphNodeEntry -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activityGraphHash

        -
        activityGraphHash: number
        - -
        -
        - -

        activityGraphNodeHash

        -
        activityGraphNodeHash: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonechallengeactivityphase.html b/docs/interfaces/idestinymilestonechallengeactivityphase.html deleted file mode 100644 index 0df383a..0000000 --- a/docs/interfaces/idestinymilestonechallengeactivityphase.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - IDestinyMilestoneChallengeActivityPhase | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneChallengeActivityPhase

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneChallengeActivityPhase -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        phaseHash

        -
        phaseHash: number
        - -
        -
        -

        The hash identifier of the activity's phase.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonechallengedefinition.html b/docs/interfaces/idestinymilestonechallengedefinition.html deleted file mode 100644 index 3a3d815..0000000 --- a/docs/interfaces/idestinymilestonechallengedefinition.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - IDestinyMilestoneChallengeDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneChallengeDefinition

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneChallengeDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        challengeObjectiveHash

        -
        challengeObjectiveHash: number
        - -
        -
        -

        The challenge related to this milestone.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonecontent.html b/docs/interfaces/idestinymilestonecontent.html deleted file mode 100644 index 7887522..0000000 --- a/docs/interfaces/idestinymilestonecontent.html +++ /dev/null @@ -1,268 +0,0 @@ - - - - - - IDestinyMilestoneContent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneContent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents localized, extended content related to Milestones. This is - intentionally returned by a separate endpoint and not with Character-level - Milestone data because we do not put localized data into standard Destiny - responses, both for brevity of response and for caching purposes. If you really - need this data, hit the Milestone Content endpoint.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneContent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        about

        -
        about: string
        - -
        -
        -

        The "About this Milestone" text from the Firehose.

        -
        -
        -
        -
        - -

        itemCategories

        - - -
        -
        -

        If DPS has defined items related to this Milestone, they can categorize those - items in the Firehose. That data will then be returned as item categories here.

        -
        -
        -
        -
        - -

        status

        -
        status: string
        - -
        -
        -

        The Current Status of the Milestone, as driven by the Firehose.

        -
        -
        -
        -
        - -

        tips

        -
        tips: string[]
        - -
        -
        -

        A list of tips, provided by the Firehose.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonecontentitemcategory.html b/docs/interfaces/idestinymilestonecontentitemcategory.html deleted file mode 100644 index e0414a9..0000000 --- a/docs/interfaces/idestinymilestonecontentitemcategory.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IDestinyMilestoneContentItemCategory | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneContentItemCategory

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Part of our dynamic, localized Milestone content is arbitrary categories of - items. These are built in our content management system, and thus aren't the - same as programmatically generated rewards.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneContentItemCategory -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        itemHashes

        -
        itemHashes: number[]
        - -
        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        -
        - -

        title

        -
        title: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonedefinition.html b/docs/interfaces/idestinymilestonedefinition.html deleted file mode 100644 index 481814f..0000000 --- a/docs/interfaces/idestinymilestonedefinition.html +++ /dev/null @@ -1,664 +0,0 @@ - - - - - - IDestinyMilestoneDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Milestones are an in-game concept where they're attempting to tell you what you - can do next in-game.

        -
        -

        If that sounds a lot like Advisors in Destiny 1, it is! So we threw out Advisors - in the Destiny 2 API and tacked all of the data we would have put on Advisors - onto Milestones instead.

        -

        Each Milestone represents something going on in the game right now:

        -
          -
        • A "ritual activity" you can perform, like nightfall

          -
        • -
        • A "special event" that may have activities related to it, like Taco Tuesday ( - there's no Taco Tuesday in Destiny 2)

          -
        • -
        • A checklist you can fulfill, like helping your Clan complete all of its weekly - objectives

          -
        • -
        • A tutorial quest you can play through, like the introduction to the Crucible.

          -
        • -
        -

        Most of these milestones appear in game as well. Some of them are BNet only, - because we're so extra. You're welcome.

        -

        There are some important caveats to understand about how we currently render - Milestones and their deficiencies. The game currently doesn't have any content - that actually tells you oughtright what the Milestone is: that is to say, what - you'll be doing. The best we get is either a description of the overall - Milestone, or of the Quest that the Milestone is having you partake in: which is - usually something that assumes you already know what it's talking about, like " - Complete 5 Challenges". 5 Challenges for what? What's a challenge? These are not - questions that the Milestone data will answer for you unfortunately.

        -

        This isn't great, and in the future I'd like to add some custom text to give you - more contextual information to pass on to your users. But for now, you can do - what we do to render what little display info we do have:

        -

        Start by looking at the currently active quest (ideally, you've fetched - DestinyMilestone or DestinyPublicMilestone data from the API, so you know the - currently active quest for the Milestone in question). Look up the Quests - property in the Milestone Definition, and check if it has display properties. If - it does, show that as the description of the Milestone. If it doesn't, fall back - on the Milestone's description.

        -

        This approach will let you avoid, whenever possible, the even less useful (and - sometimes nonexistant) milestone-level names and descriptions.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activities

        - - -
        -
        -

        A Milestone can now be represented by one or more activities directly (without a - backing Quest), and that activity can have many challenges, modifiers, and - related to it.

        -
        -
        -
        -
        - -

        defaultOrder

        -
        defaultOrder: number
        - -
        -
        - -

        displayProperties

        - - -
        -
        - -

        explorePrioritizesActivityImage

        -
        explorePrioritizesActivityImage: boolean
        - -
        -
        -

        If TRUE, "Explore Destiny" (the front page of BNet and the companion app) - prioritize using the activity image over any overriding Quest or Milestone image - provided. This unfortunate hack is brought to you by Trials of The Nine.

        -
        -
        -
        -
        - -

        friendlyName

        -
        friendlyName: string
        - -
        -
        -

        If the milestone has a friendly identifier for association with other features - - such as Recruiting - that identifier can be found here. This is "friendly" in - that it looks better in a URL than whatever the identifier for the Milestone - actually is.

        -
        -
        -
        -
        - -

        hasPredictableDates

        -
        hasPredictableDates: boolean
        - -
        -
        -

        A shortcut for clients - and the server - to understand whether we can predict - the start and end dates for this event. In practice, there are multiple ways - that an event could have predictable date ranges, but not all events will be - able to be predicted via any mechanism (for instance, events that are manually - triggered on and off)

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        image

        -
        image: string
        - -
        -
        -

        A custom image someone made just for the milestone. Isn't that special?

        -
        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        isInGameMilestone

        -
        isInGameMilestone: boolean
        - -
        -
        -

        Some milestones are explicit objectives that you can see and interact with in - the game. Some milestones are more conceptual, built by BNet to help advise you - on activities and events that happen in-game but that aren't explicitly shown in - game as Milestones. If this is TRUE, you can see this as a milestone in the game. - If this is FALSE, it's an event or activity you can participate in, but you won' - t see it as a Milestone in the game's UI.

        -
        -
        -
        -
        - -

        milestoneType

        -
        milestoneType: DestinyMilestoneType
        - -
        -
        -

        An enumeration listing one of the possible types of milestones. Check out the - DestinyMilestoneType enum for more info!

        -
        -
        -
        -
        - -

        quests

        -
        quests: object
        - -
        -
        -

        The full set of possible Quests that give the overview of the Milestone event/ - activity in question. Only one of these can be active at a time for a given - Conceptual Milestone, but many of them may be "available" for the user to choose - from. (for instance, with Milestones you can choose from the three available - Quests, but only one can be active at a time) Keyed by the quest item.

        -
        -

        As of Forsaken (~September 2018), Quest-style Milestones are being removed for - many types of activities. There will likely be further revisions to the - Milestone concept in the future.

        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        recruitable

        -
        recruitable: boolean
        - -
        -
        -

        If True, then the Milestone has been integrated with BNet's recruiting feature.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        rewards

        -
        rewards: object
        - -
        -
        -

        If this milestone can provide rewards, this will define the categories into - which the individual reward entries are placed.

        -
        -

        This is keyed by the Category's hash, which is only guaranteed to be unique - within a given Milestone.

        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        showInExplorer

        -
        showInExplorer: boolean
        - -
        -
        -

        If TRUE, this entry should be returned in the list of milestones for the " - Explore Destiny" (i.e. new BNet homepage) features of Bungie.net (as long as the - underlying event is active) Note that this is a property specifically used by - BNet and the companion app for the "Live Events" feature of the front page/ - welcome view: it's not a reflection of what you see in-game.

        -
        -
        -
        -
        - -

        showInMilestones

        -
        showInMilestones: boolean
        - -
        -
        -

        Determines whether we'll show this Milestone in the user's personal Milestones - list.

        -
        -
        -
        -
        - -

        values

        -
        values: object
        - -
        -
        -

        Sometimes, milestones will have arbitrary values associated with them that are - of interest to us or to third party developers. This is the collection of those - values' definitions, keyed by the identifier of the value and providing useful - definition information such as localizable names and descriptions for the value.

        -
        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        vendors

        - - -
        -
        -

        Sometimes, milestones will have rewards provided by Vendors. This definition - gives the information needed to understand which vendors are relevant, the order - in which they should be returned if order matters, and the conditions under - which the Vendor is relevant to the user.

        -
        -
        -
        -
        - -

        vendorsDisplayTitle

        -
        vendorsDisplayTitle: string
        - -
        -
        -

        If you're going to show Vendors for the Milestone, you can use this as a - localized "header" for the section where you show that vendor data. It'll - provide a more context-relevant clue about what the vendor's role is in the - Milestone.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonequest.html b/docs/interfaces/idestinymilestonequest.html deleted file mode 100644 index be6fcbf..0000000 --- a/docs/interfaces/idestinymilestonequest.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - - IDestinyMilestoneQuest | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneQuest

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If a Milestone has one or more Quests, this will contain the live information - for the character's status with one of those quests.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneQuest -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activity

        - - -
        -
        -

        IF the Milestone has an active Activity that can give you greater details - about what you need to do, it will be returned here. Remember to associate this - with the DestinyMilestoneDefinition's activities to get details about the - activity, including what specific quest it is related to if you have multiple - quests to choose from.

        -
        -
        -
        -
        - -

        challenges

        - - -
        -
        -

        The activities referred to by this quest can have many associated challenges. - They are all contained here, with activityHashes so that you can associate them - with the specific activity variants in which they can be found. In retrospect, I - probably should have put these under the specific Activity Variants, but it's - too late to change it now. Theoretically, a quest without Activities can still - have Challenges, which is why this is on a higher level than activity/variants, - but it probably should have been in both places. That may come as a later - revision.

        -
        -
        -
        -
        - -

        questItemHash

        -
        questItemHash: number
        - -
        -
        -

        Quests are defined as Items in content. As such, this is the hash identifier of - the DestinyInventoryItemDefinition that represents this quest. It will have - pointers to all of the steps in the quest, and display information for the quest - (title, description, icon etc) Individual steps will be referred to in the Quest - item's DestinyInventoryItemDefinition.setData property, and themselves are Items - with their own renderable data.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        status

        - - -
        -
        -

        The current status of the quest for the character making the request.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonequestdefinition.html b/docs/interfaces/idestinymilestonequestdefinition.html deleted file mode 100644 index 9de8efd..0000000 --- a/docs/interfaces/idestinymilestonequestdefinition.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - IDestinyMilestoneQuestDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneQuestDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Any data we need to figure out whether this Quest Item is the currently active - one for the conceptual Milestone. Even just typing this description, I already - regret it.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneQuestDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activities

        -
        activities: object
        - -
        -
        -

        The full set of all possible "conceptual activities" that are related to this - Milestone. Tiers or alternative modes of play within these conceptual activities - will be defined as sub-entities. Keyed by the Conceptual Activity Hash. Use the - key to look up DestinyActivityDefinition.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        Optional destinationHash

        -
        destinationHash: number
        - -
        -
        -

        Sometimes, a Milestone's quest is related to an entire Destination rather than a - specific activity. In that situation, this will be the hash of that Destination. - Hotspots are currently the only Milestones that expose this data, but that does - not preclude this data from being returned for other Milestones in the future.

        -
        -

        Mapped to IDestinyDestinationDefinition in the manifest.

        -
        -
        -
        - -

        displayProperties

        - - -
        -
        -

        The individual quests may have different definitions from the overall milestone: - if there's a specific active quest, use these displayProperties instead of that - of the overall DestinyMilestoneDefinition.

        -
        -
        -
        -
        - -

        overrideImage

        -
        overrideImage: string
        - -
        -
        -

        If populated, this image can be shown instead of the generic milestone's image - when this quest is live, or it can be used to show a background image for the - quest itself that differs from that of the Activity or the Milestone.

        -
        -
        -
        -
        - -

        questItemHash

        -
        questItemHash: number
        - -
        -
        -

        The item representing this Milestone quest. Use this hash to look up the - DestinyInventoryItemDefinition for the quest to find its steps and human - readable data.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        questRewards

        - - -
        -
        -

        The rewards you will get for completing this quest, as best as we could extract - them from our data. Sometimes, it'll be a decent amount of data. Sometimes, it's - going to be sucky. Sorry.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonequestrewarditem.html b/docs/interfaces/idestinymilestonequestrewarditem.html deleted file mode 100644 index b8e428c..0000000 --- a/docs/interfaces/idestinymilestonequestrewarditem.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - IDestinyMilestoneQuestRewardItem | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneQuestRewardItem

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A subclass of DestinyItemQuantity, that provides not just the item and its - quantity but also information that BNet can - at some point - use internally to - provide more robust runtime information about the item's qualities.

        -
        -

        If you want it, please ask! We're just out of time to wire it up right now. Or a - clever person just may do it with our existing endpoints.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneQuestRewardItem -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        itemHash

        -
        itemHash: number
        - -
        -
        -

        The hash identifier for the item in question. Use it to look up the item's - DestinyInventoryItemDefinition.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        Optional itemInstanceId

        -
        itemInstanceId: string
        - -
        -
        -

        If this quantity is referring to a specific instance of an item, this will have - the item's instance ID. Normally, this will be null.

        -
        -
        -
        -
        - -

        quantity

        -
        quantity: number
        - -
        -
        -

        The amount of the item needed/available depending on the context of where - DestinyItemQuantity is being used.

        -
        -
        -
        -
        - -

        Optional vendorHash

        -
        vendorHash: number
        - -
        -
        -

        The quest reward item may be associated with a vendor. If so, this is that - vendor. Use this hash to look up the DestinyVendorDefinition.

        -
        -

        Mapped to IDestinyVendorDefinition in the manifest.

        -
        -
        -
        - -

        Optional vendorItemIndex

        -
        vendorItemIndex: number
        - -
        -
        -

        The quest reward item may be associated with a vendor. If so, this is the - index of the item being sold, which we can use at runtime to find instanced item - information for the reward item.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonequestrewardsdefinition.html b/docs/interfaces/idestinymilestonequestrewardsdefinition.html deleted file mode 100644 index 1aa9bb9..0000000 --- a/docs/interfaces/idestinymilestonequestrewardsdefinition.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - - IDestinyMilestoneQuestRewardsDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneQuestRewardsDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If rewards are given in a quest - as opposed to overall in the entire Milestone - - there's way less to track. We're going to simplify this contract as a result. - However, this also gives us the opportunity to potentially put more than just - item information into the reward data if we're able to mine it out in the future. - Remember this if you come back and ask "why are quest reward items nested - inside of their own class?"

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneQuestRewardsDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        items

        - - -
        -
        -

        The items that represent your reward for completing the quest.

        -
        -

        Be warned, these could be "dummy" items: items that are only used to render a - good-looking in-game tooltip, but aren't the actual items themselves.

        -

        For instance, when experience is given there's often a dummy item representing " - experience", with quantity being the amount of experience you got. We don't have - a programmatic association between those and whatever Progression is actually - getting that experience... yet.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonerewardcategory.html b/docs/interfaces/idestinymilestonerewardcategory.html deleted file mode 100644 index c480b14..0000000 --- a/docs/interfaces/idestinymilestonerewardcategory.html +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - IDestinyMilestoneRewardCategory | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneRewardCategory

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents a category of "summary" rewards that can be earned for the Milestone - regardless of specific quest rewards that can be earned.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneRewardCategory -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        entries

        - - -
        -
        -

        The individual reward entries for this category, and their status.

        -
        -
        -
        -
        - -

        rewardCategoryHash

        -
        rewardCategoryHash: number
        - -
        -
        -

        Look up the relevant DestinyMilestoneDefinition, and then use rewardCategoryHash - to look up the category info in DestinyMilestoneDefinition.rewards.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonerewardcategorydefinition.html b/docs/interfaces/idestinymilestonerewardcategorydefinition.html deleted file mode 100644 index 726c8d5..0000000 --- a/docs/interfaces/idestinymilestonerewardcategorydefinition.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - IDestinyMilestoneRewardCategoryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneRewardCategoryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The definition of a category of rewards, that contains many individual rewards.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneRewardCategoryDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        categoryHash

        -
        categoryHash: number
        - -
        -
        -

        Identifies the reward category. Only guaranteed unique within this specific - component!

        -
        -
        -
        -
        - -

        categoryIdentifier

        -
        categoryIdentifier: string
        - -
        -
        -

        The string identifier for the category, if you want to use it for some end. - Guaranteed unique within the specific component.

        -
        -
        -
        -
        - -

        displayProperties

        - - -
        -
        -

        Hopefully this is obvious by now.

        -
        -
        -
        -
        - -

        order

        -
        order: number
        - -
        -
        -

        If you want to use BNet's recommended order for rendering categories - programmatically, use this value and compare it to other categories to determine - the order in which they should be rendered. I don't feel great about putting - this here, I won't lie.

        -
        -
        -
        -
        - -

        rewardEntries

        -
        rewardEntries: object
        - -
        -
        -

        If this milestone can provide rewards, this will define the sets of rewards that - can be earned, the conditions under which they can be acquired, internal data - that we'll use at runtime to determine whether you've already earned or redeemed - this set of rewards, and the category that this reward should be placed under.

        -
        -
        -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonerewardentry.html b/docs/interfaces/idestinymilestonerewardentry.html deleted file mode 100644 index 4cbb286..0000000 --- a/docs/interfaces/idestinymilestonerewardentry.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - IDestinyMilestoneRewardEntry | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneRewardEntry

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The character-specific data for a milestone's reward entry. See - DestinyMilestoneDefinition for more information about Reward Entries.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneRewardEntry -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        earned

        -
        earned: boolean
        - -
        -
        -

        If TRUE, the player has earned this reward.

        -
        -
        -
        -
        - -

        redeemed

        -
        redeemed: boolean
        - -
        -
        -

        If TRUE, the player has redeemed/picked up/obtained this reward. Feel free to - alias this to "gotTheShinyBauble" in your own codebase.

        -
        -
        -
        -
        - -

        rewardEntryHash

        -
        rewardEntryHash: number
        - -
        -
        -

        The identifier for the reward entry in question. It is important to look up the - related DestinyMilestoneRewardEntryDefinition to get the static details about - the reward, which you can do by looking up the milestone's - DestinyMilestoneDefinition and examining the DestinyMilestoneDefinition.rewards[ - rewardCategoryHash].rewardEntries[rewardEntryHash] data.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonerewardentrydefinition.html b/docs/interfaces/idestinymilestonerewardentrydefinition.html deleted file mode 100644 index e441e6c..0000000 --- a/docs/interfaces/idestinymilestonerewardentrydefinition.html +++ /dev/null @@ -1,310 +0,0 @@ - - - - - - IDestinyMilestoneRewardEntryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneRewardEntryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The definition of a specific reward, which may be contained in a category of - rewards and that has optional information about how it is obtained.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneRewardEntryDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        -

        For us to bother returning this info, we should be able to return some kind of - information about why these rewards are grouped together. This is ideally that - information. Look at how confident I am that this will always remain true.

        -
        -
        -
        -
        - -

        items

        - - -
        -
        -

        The items you will get as rewards, and how much of it you'll get.

        -
        -
        -
        -
        - -

        order

        -
        order: number
        - -
        -
        -

        If you want to follow BNet's ordering of these rewards, use this number within a - given category to order the rewards. Yeah, I know. I feel dirty too.

        -
        -
        -
        -
        - -

        rewardEntryHash

        -
        rewardEntryHash: number
        - -
        -
        -

        The identifier for this reward entry. Runtime data will refer to reward entries - by this hash. Only guaranteed unique within the specific Milestone.

        -
        -
        -
        -
        - -

        rewardEntryIdentifier

        -
        rewardEntryIdentifier: string
        - -
        -
        -

        The string identifier, if you care about it. Only guaranteed unique within the - specific Milestone.

        -
        -
        -
        -
        - -

        Optional vendorHash

        -
        vendorHash: number
        - -
        -
        -

        If this reward is redeemed at a Vendor, this is the hash of the Vendor to go to - in order to redeem the reward. Use this hash to look up the - DestinyVendorDefinition.

        -
        -

        Mapped to IDestinyVendorDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonevaluedefinition.html b/docs/interfaces/idestinymilestonevaluedefinition.html deleted file mode 100644 index 3b5cb04..0000000 --- a/docs/interfaces/idestinymilestonevaluedefinition.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - - IDestinyMilestoneValueDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneValueDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The definition for information related to a key/value pair that is relevant for - a particular Milestone or component within the Milestone.

        -
        -

        This lets us more flexibly pass up information that's useful to someone, even if - it's not necessarily us.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneValueDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        - -

        key

        -
        key: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonevendor.html b/docs/interfaces/idestinymilestonevendor.html deleted file mode 100644 index 1cefe6c..0000000 --- a/docs/interfaces/idestinymilestonevendor.html +++ /dev/null @@ -1,233 +0,0 @@ - - - - - - IDestinyMilestoneVendor | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneVendor

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If a Milestone has one or more Vendors that are relevant to it, this will - contain information about that vendor that you can choose to show.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneVendor -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        Optional previewItemHash

        -
        previewItemHash: number
        - -
        -
        -

        If this vendor is featuring a specific item for this event, this will be the - hash identifier of that item. I'm taking bets now on how long we go before this - needs to be a list or some other, more complex representation instead and I - deprecate this too. I'm going to go with 5 months. Calling it now, 2017-09-14 at - 9:46pm PST.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        vendorHash

        -
        vendorHash: number
        - -
        -
        -

        The hash identifier of the Vendor related to this Milestone. You can show useful - things from this, such as thier Faction icon or whatever you might care about.

        -
        -

        Mapped to IDestinyVendorDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinymilestonevendordefinition.html b/docs/interfaces/idestinymilestonevendordefinition.html deleted file mode 100644 index 40d4e8a..0000000 --- a/docs/interfaces/idestinymilestonevendordefinition.html +++ /dev/null @@ -1,211 +0,0 @@ - - - - - - IDestinyMilestoneVendorDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyMilestoneVendorDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If the Milestone or a component has vendors whose inventories could/should be - displayed that are relevant to it, this will return the vendor in question.

        -
        -

        It also contains information we need to determine whether that vendor is - actually relevant at the moment, given the user's current state.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyMilestoneVendorDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        vendorHash

        -
        vendorHash: number
        - -
        -
        -

        The hash of the vendor whose wares should be shown as associated with the - Milestone.

        -
        -

        Mapped to IDestinyVendorDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinynodeactivationrequirement.html b/docs/interfaces/idestinynodeactivationrequirement.html deleted file mode 100644 index 5926171..0000000 --- a/docs/interfaces/idestinynodeactivationrequirement.html +++ /dev/null @@ -1,238 +0,0 @@ - - - - - - IDestinyNodeActivationRequirement | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyNodeActivationRequirement

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Talent nodes have requirements that must be met before they can be activated.

        -
        -

        This describes the material costs, the Level of the Talent Grid's progression - required, and other conditional information that limits whether a talent node - can be activated.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyNodeActivationRequirement -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        gridLevel

        -
        gridLevel: number
        - -
        -
        -

        The Progression level on the Talent Grid required to activate this node.

        -
        -

        See DestinyTalentGridDefinition.progressionHash for the related Progression, and - read DestinyProgressionDefinition's documentation to learn more about - Progressions.

        -
        -
        -
        - -

        materialRequirementHashes

        -
        materialRequirementHashes: number[]
        - -
        -
        -

        The list of hash identifiers for material requirement sets: materials that are - required for the node to be activated. See - DestinyMaterialRequirementSetDefinition for more information about material - requirements.

        -
        -

        In this case, only a single DestinyMaterialRequirementSetDefinition will be - chosen from this list, and we won't know which one will be chosen until an - instance of the item is created.

        -

        Mapped to IDestinyMaterialRequirementSetDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinynodesocketreplaceresponse.html b/docs/interfaces/idestinynodesocketreplaceresponse.html deleted file mode 100644 index 6994e77..0000000 --- a/docs/interfaces/idestinynodesocketreplaceresponse.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - - IDestinyNodeSocketReplaceResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyNodeSocketReplaceResponse

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This is a bit of an odd duck. Apparently, if talent nodes steps have this data, - the game will go through on step activation and alter the first Socket it finds - on the item that has a type matching the given socket type, inserting the - indicated plug item.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyNodeSocketReplaceResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        plugItemHash

        -
        plugItemHash: number
        - -
        -
        -

        The hash identifier of the plug item that will be inserted into the socket found.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        socketTypeHash

        -
        socketTypeHash: number
        - -
        -
        -

        The hash identifier of the socket type to find amidst the item's sockets (the - item to which this talent grid is attached). See DestinyInventoryItemDefinition. - sockets.socketEntries to find the socket type of sockets on the item in question.

        -
        -

        Mapped to IDestinySocketTypeDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinynodestepdefinition.html b/docs/interfaces/idestinynodestepdefinition.html deleted file mode 100644 index 16d3899..0000000 --- a/docs/interfaces/idestinynodestepdefinition.html +++ /dev/null @@ -1,566 +0,0 @@ - - - - - - IDestinyNodeStepDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyNodeStepDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This defines the properties of a "Talent Node Step". When you see a talent node - in game, the actual visible properties that you see (its icon, description, the - perks and stats it provides) are not provided by the Node itself, but rather by - the currently active Step on the node.

        -
        -

        When a Talent Node is activated, the currently active step's benefits are - conferred upon the item and character.

        -

        The currently active step on talent nodes are determined when an item is first - instantiated. Sometimes it is random, sometimes it is more deterministic ( - particularly when a node has only a single step).

        -

        Note that, when dealing with Talent Node Steps, you must ensure that you have - the latest version of content. stepIndex and nodeStepHash - two ways of - identifying the step within a node - are both content version dependent, and - thus are subject to change between content updates.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyNodeStepDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activationRequirement

        -
        activationRequirement: IDestinyNodeActivationRequirement
        - -
        -
        -

        If the step has requirements for activation (they almost always do, if nothing - else than for the Talent Grid's Progression to have reached a certain level), - they will be defined here.

        -
        -
        -
        -
        - -

        affectsLevel

        -
        affectsLevel: boolean
        - -
        -
        -

        If true, this step can affect the level of the item. See - DestinyInventoryItemDefintion for more information about item levels and their - effect on stats.

        -
        -
        -
        -
        - -

        affectsQuality

        -
        affectsQuality: boolean
        - -
        -
        -

        If this is true, the step affects the item's Quality in some way. See - DestinyInventoryItemDefinition for more information about the meaning of Quality. - I already made a joke about Zen and the Art of Motorcycle Maintenance elsewhere - in the documentation, so I will avoid doing it again. Oops too late

        -
        -
        -
        -
        - -

        canActivateNextStep

        -
        canActivateNextStep: boolean
        - -
        -
        -

        There was a time when talent nodes could be activated multiple times, and the - effects of subsequent Steps would be compounded on each other, essentially " - upgrading" the node. We have moved away from this, but theoretically the - capability still exists.

        -
        -

        I continue to return this in case it is used in the future: if true and this - step is the current step in the node, you are allowed to activate the node a - second time to receive the benefits of the next step in the node, which will - then become the active step.

        -
        -
        -
        - -

        damageType

        -
        damageType: DamageType
        - -
        -
        -

        An enum representing a damage type granted by activating this step, if any.

        -
        -
        -
        -
        - -

        Optional damageTypeHash

        -
        damageTypeHash: number
        - -
        -
        -

        If the step provides a damage type, this will be the hash identifier used to - look up the damage type's DestinyDamageTypeDefinition.

        -
        -

        Mapped to IDestinyDamageTypeDefinition in the manifest.

        -
        -
        -
        - -

        displayProperties

        - - -
        -
        -

        These are the display properties actually used to render the Talent Node. The - currently active step's displayProperties are shown.

        -
        -
        -
        -
        - -

        interactionDescription

        -
        interactionDescription: string
        - -
        -
        -

        If you can interact with this node in some way, this is the localized - description of that interaction.

        -
        -
        -
        -
        - -

        isNextStepRandom

        -
        isNextStepRandom: boolean
        - -
        -
        -

        If true, the next step to be chosen is random, and if you're allowed to activate - the next step. (if canActivateNextStep = true)

        -
        -
        -
        -
        - -

        nextStepIndex

        -
        nextStepIndex: number
        - -
        -
        -

        The stepIndex of the next step in the talent node, or -1 if this is the last - step or if the next step to be chosen is random.

        -
        -

        This doesn't really matter anymore unless canActivateNextStep begins to be used - again.

        -
        -
        -
        - -

        nodeStepHash

        -
        nodeStepHash: number
        - -
        -
        -

        The hash of this node step. Unfortunately, while it can be used to uniquely - identify the step within a node, it is also content version dependent and should - not be relied on without ensuring you have the latest vesion of content.

        -
        -
        -
        -
        - -

        perkHashes

        -
        perkHashes: number[]
        - -
        -
        -

        The list of hash identifiers for Perks (DestinySandboxPerkDefinition) that are - applied when this step is active. Perks provide a variety of benefits and - modifications - examine DestinySandboxPerkDefinition to learn more.

        -
        -

        Mapped to IDestinySandboxPerkDefinition in the manifest.

        -
        -
        -
        - -

        socketReplacements

        -
        socketReplacements: IDestinyNodeSocketReplaceResponse[]
        - -
        -
        -

        If this step is activated, this will be a list of information used to replace - socket items with new Plugs. See DestinyInventoryItemDefinition for more - information about sockets and plugs.

        -
        -
        -
        -
        - -

        startProgressionBarAtProgress

        -
        startProgressionBarAtProgress: number
        - -
        -
        -

        When the Talent Grid's progression reaches this value, the circular "progress - bar" that surrounds the talent node should be shown.

        -
        -

        This also indicates the lower bound of said progress bar, with the upper bound - being the progress required to reach activationRequirement.gridLevel. (at some - point I should precalculate the upper bound and put it in the definition to save - people time)

        -
        -
        -
        - -

        statHashes

        -
        statHashes: number[]
        - -
        -
        -

        When the step provides stat benefits on the item or character, this is the list - of hash identifiers for stats (DestinyStatDefinition) that are provided.

        -
        -

        Mapped to IDestinyStatDefinition in the manifest.

        -
        -
        -
        - -

        stepGroups

        - - -
        -
        -

        In Destiny 1, the Armory's Perk Filtering was driven by a concept of - TalentNodeStepGroups: categorizations of talent nodes based on their - functionality. While the Armory isn't a BNet-facing thing for now, and the new - Armory will need to account for Sockets rather than Talent Nodes, this - categorization capability feels useful enough to still keep around.

        -
        -
        -
        -
        - -

        stepIndex

        -
        stepIndex: number
        - -
        -
        -

        The index of this step in the list of Steps on the Talent Node.

        -
        -

        Unfortunately, this is the closest thing we have to an identifier for the Step: - steps are not provided a content version agnostic identifier. This means that, - when you are dealing with talent nodes, you will need to first ensure that you - have the latest version of content.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyobjectivedefinition.html b/docs/interfaces/idestinyobjectivedefinition.html deleted file mode 100644 index 4553ebc..0000000 --- a/docs/interfaces/idestinyobjectivedefinition.html +++ /dev/null @@ -1,592 +0,0 @@ - - - - - - IDestinyObjectiveDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyObjectiveDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Defines an "Objective".

        -
        -

        An objective is a specific task you should accomplish in the game. These are - referred to by:

        -
          -
        • Quest Steps (which are DestinyInventoryItemDefinition entities with Objectives)

          -
        • -
        • Challenges (which are Objectives defined on an DestinyActivityDefintion)

          -
        • -
        • Milestones (which refer to Objectives that are defined on both Quest Steps and - Activities)

          -
        • -
        • Anything else that the designers decide to do later.

          -
        • -
        -

        Objectives have progress, a notion of having been Completed, human readable data - describing the task to be accomplished, and a lot of optional tack-on data that - can enhance the information provided about the task.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyObjectiveDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        allowNegativeValue

        -
        allowNegativeValue: boolean
        - -
        -
        -

        If true, the value is allowed to go negative.

        -
        -
        -
        -
        - -

        allowOvercompletion

        -
        allowOvercompletion: boolean
        - -
        -
        -

        If True, the progress will continue even beyond the point where the objective - met its minimum completion requirements. Your UI will have to accommodate it.

        -
        -
        -
        -
        - -

        allowValueChangeWhenCompleted

        -
        allowValueChangeWhenCompleted: boolean
        - -
        -
        -

        If true, you can effectively "un-complete" this objective if you lose progress - after crossing the completion threshold.

        -
        -

        If False, once you complete the task it will remain completed forever by locking - the value.

        -
        -
        -
        - -

        completedValueStyle

        -
        completedValueStyle: DestinyUnlockValueUIStyle
        - -
        -
        -

        The style to use when the objective is completed.

        -
        -
        -
        -
        - -

        completionValue

        -
        completionValue: number
        - -
        -
        -

        The value that the unlock value defined in unlockValueHash must reach in order - for the objective to be considered Completed. Used in calculating progress and - completion status.

        -
        -
        -
        -
        - -

        displayProperties

        - - -
        -
        -

        Ideally, this should tell you what your task is. I'm not going to lie to you - though. Sometimes this doesn't have useful information at all. Which sucks, but - there's nothing either of us can do about it.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        inProgressValueStyle

        -
        inProgressValueStyle: DestinyUnlockValueUIStyle
        - -
        -
        -

        The style to use when the objective is still in progress.

        -
        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        isCountingDownward

        -
        isCountingDownward: boolean
        - -
        -
        -

        If true, completion means having an unlock value less than or equal to the - completionValue.

        -
        -

        If False, completion means having an unlock value greater than or equal to the - completionValue.

        -
        -
        -
        - -

        locationHash

        -
        locationHash: number
        - -
        -
        -

        OPTIONAL: a hash identifier for the location at which this objective must be - accomplished, if there is a location defined. Look up the - DestinyLocationDefinition for this hash for that additional location info.

        -
        -

        Mapped to IDestinyLocationDefinition in the manifest.

        -
        -
        -
        - -

        minimumVisibilityThreshold

        -
        minimumVisibilityThreshold: number
        - -
        -
        -

        If nonzero, this is the minimum value at which the objective's progression - should be shown. Otherwise, don't show it yet.

        -
        -
        -
        -
        - -

        perks

        - - -
        -
        -

        If this objective enables Perks intrinsically, the conditions for that enabling - are defined here.

        -
        -
        -
        -
        - -

        progressDescription

        -
        progressDescription: string
        - -
        -
        -

        Text to describe the progress bar.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        scope

        - - -
        -
        -

        A shortcut for determining the most restrictive gating that this Objective is - set to use. This includes both the dynamic determination of progress and of - completion values. See the DestinyGatingScope enum's documentation for more - details.

        -
        -
        -
        -
        - -

        showValueOnComplete

        -
        showValueOnComplete: boolean
        - -
        -
        -

        If True, you should continue showing the progression value in the UI after it's - complete. I mean, we already do that in BNet anyways, but if you want to be - better behaved than us you could honor this flag.

        -
        -
        -
        -
        - -

        stats

        - - -
        -
        -

        If this objective enables modifications on a player's stats intrinsically, the - conditions are defined here.

        -
        -
        -
        -
        - -

        valueStyle

        - - -
        -
        -

        The UI style applied to the objective. It's an enum, take a look at - DestinyUnlockValueUIStyle for details of the possible styles. Use this info as - you wish to customize your UI.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyobjectivedisplayproperties.html b/docs/interfaces/idestinyobjectivedisplayproperties.html deleted file mode 100644 index 9766257..0000000 --- a/docs/interfaces/idestinyobjectivedisplayproperties.html +++ /dev/null @@ -1,219 +0,0 @@ - - - - - - IDestinyObjectiveDisplayProperties | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyObjectiveDisplayProperties

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyObjectiveDisplayProperties -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        Optional activityHash

        -
        activityHash: number
        - -
        -
        -

        The activity associated with this objective in the context of this item, if any.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        displayOnItemPreviewScreen

        -
        displayOnItemPreviewScreen: boolean
        - -
        -
        -

        If true, the game shows this objective on item preview screens.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyobjectiveperkentrydefinition.html b/docs/interfaces/idestinyobjectiveperkentrydefinition.html deleted file mode 100644 index 7eaaff0..0000000 --- a/docs/interfaces/idestinyobjectiveperkentrydefinition.html +++ /dev/null @@ -1,231 +0,0 @@ - - - - - - IDestinyObjectivePerkEntryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyObjectivePerkEntryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Defines the conditions under which an intrinsic perk is applied while - participating in an Objective.

        -
        -

        These perks will generally not be benefit-granting perks, but rather a perk that - modifies gameplay in some interesting way.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyObjectivePerkEntryDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        perkHash

        -
        perkHash: number
        - -
        -
        -

        The hash identifier of the DestinySandboxPerkDefinition that will be applied to - the character.

        -
        -

        Mapped to IDestinySandboxPerkDefinition in the manifest.

        -
        -
        -
        - -

        style

        - - -
        -
        -

        An enumeration indicating whether it will be applied as long as the Objective is - active, when it's completed, or until it's completed.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyobjectiveprogress.html b/docs/interfaces/idestinyobjectiveprogress.html deleted file mode 100644 index a43dc0f..0000000 --- a/docs/interfaces/idestinyobjectiveprogress.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - - IDestinyObjectiveProgress | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyObjectiveProgress

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Returns data about a character's status with a given Objective. Combine with - DestinyObjectiveDefinition static data for display purposes.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyObjectiveProgress -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        Optional activityHash

        -
        activityHash: number
        - -
        -
        -

        If the Objective has an Activity associated with it, this is the unique - identifier of the Activity being referred to. Use to look up the - DestinyActivityDefinition in static data. This will give localized data about * - what* you should be playing for the objective to be achieved.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        complete

        -
        complete: boolean
        - -
        -
        -

        Whether or not the Objective is completed.

        -
        -
        -
        -
        - -

        completionValue

        -
        completionValue: number
        - -
        -
        -

        As of Forsaken, objectives' completion value is determined dynamically at - runtime.

        -
        -

        This value represents the threshold of progress you need to surpass in order for - this objective to be considered "complete".

        -

        If you were using objective data, switch from using the - DestinyObjectiveDefinition's "completionValue" to this value.

        -
        -
        -
        - -

        Optional destinationHash

        -
        destinationHash: number
        - -
        -
        -

        If the Objective has a Destination associated with it, this is the unique - identifier of the Destination being referred to. Use to look up the - DestinyDestinationDefinition in static data. This will give localized data about - where in the universe the objective should be achieved.

        -
        -

        Mapped to IDestinyDestinationDefinition in the manifest.

        -
        -
        -
        - -

        objectiveHash

        -
        objectiveHash: number
        - -
        -
        -

        The unique identifier of the Objective being referred to. Use to look up the - DestinyObjectiveDefinition in static data.

        -
        -

        Mapped to IDestinyObjectiveDefinition in the manifest.

        -
        -
        -
        - -

        Optional progress

        -
        progress: number
        - -
        -
        -

        If progress has been made, and the progress can be measured numerically, this - will be the value of that progress. You can compare it to the - DestinyObjectiveDefinition.completionValue property for current vs. upper bounds, - and use DestinyObjectiveDefinition.valueStyle to determine how this should be - rendered. Note that progress, in Destiny 2, need not be a literal numeric - progression. It could be one of a number of possible values, even a Timestamp. - Always examine DestinyObjectiveDefinition.valueStyle before rendering progress.

        -
        -
        -
        -
        - -

        visible

        -
        visible: boolean
        - -
        -
        -

        If this is true, the objective is visible in-game. Otherwise, it's not yet - visible to the player. Up to you if you want to honor this property.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyobjectivestatentrydefinition.html b/docs/interfaces/idestinyobjectivestatentrydefinition.html deleted file mode 100644 index d1e4226..0000000 --- a/docs/interfaces/idestinyobjectivestatentrydefinition.html +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - IDestinyObjectiveStatEntryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyObjectiveStatEntryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Defines the conditions under which stat modifications will be applied to a - Character while participating in an objective.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyObjectiveStatEntryDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        stat

        - - -
        -
        -

        The stat being modified, and the value used.

        -
        -
        -
        -
        - -

        style

        - - -
        -
        -

        Whether it will be applied as long as the objective is active, when it's - completed, or until it's completed.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyparentitemoverride.html b/docs/interfaces/idestinyparentitemoverride.html deleted file mode 100644 index 50ac5ab..0000000 --- a/docs/interfaces/idestinyparentitemoverride.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IDestinyParentItemOverride | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyParentItemOverride

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyParentItemOverride -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        additionalEquipRequirementsDisplayStrings

        -
        additionalEquipRequirementsDisplayStrings: string[]
        - -
        -
        - -

        pipIcon

        -
        pipIcon: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyperkreference.html b/docs/interfaces/idestinyperkreference.html deleted file mode 100644 index 9dc2f26..0000000 --- a/docs/interfaces/idestinyperkreference.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - IDestinyPerkReference | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPerkReference

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        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.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPerkReference -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        iconPath

        -
        iconPath: string
        - -
        -
        -

        The icon for the perk.

        -
        -
        -
        -
        - -

        isActive

        -
        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.)

        -
        -
        -
        -
        - -

        perkHash

        -
        perkHash: number
        - -
        -
        -

        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.

        -
        -

        Mapped to IDestinySandboxPerkDefinition in the manifest.

        -
        -
        -
        - -

        visible

        -
        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.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyplacedefinition.html b/docs/interfaces/idestinyplacedefinition.html deleted file mode 100644 index cdb0900..0000000 --- a/docs/interfaces/idestinyplacedefinition.html +++ /dev/null @@ -1,265 +0,0 @@ - - - - - - IDestinyPlaceDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPlaceDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Okay, so Activities (DestinyActivityDefinition) take place in Destinations ( - DestinyDestinationDefinition). Destinations are part of larger locations known - as Places (you're reading its documentation right now).

        -
        -

        Places are more on the planetary scale, like "Earth" and "Your Mom."

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPlaceDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyplayer.html b/docs/interfaces/idestinyplayer.html deleted file mode 100644 index 6cae19b..0000000 --- a/docs/interfaces/idestinyplayer.html +++ /dev/null @@ -1,381 +0,0 @@ - - - - - - IDestinyPlayer | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPlayer

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPlayer -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        bungieNetUserInfo

        -
        bungieNetUserInfo: IUserInfoCard
        - -
        -
        -

        Details about the player as they are known on BungieNet. This will be undefined - if the player has marked their credential private, or does not have a BungieNet - account.

        -
        -
        -
        -
        - -

        characterClass

        -
        characterClass: string
        - -
        -
        -

        Class of the character if applicable and available.

        -
        -
        -
        -
        - -

        characterLevel

        -
        characterLevel: number
        - -
        -
        -

        Level of the character if available. Zero if it is not available.

        -
        -
        -
        -
        - -

        clanName

        -
        clanName: string
        - -
        -
        -

        Current clan name for the player. This value may be null or an empty string if - the user does not have a clan.

        -
        -
        -
        -
        - -

        clanTag

        -
        clanTag: string
        - -
        -
        -

        Current clan tag for the player. This value may be null or an empty string if - the user does not have a clan.

        -
        -
        -
        -
        - -

        classHash

        -
        classHash: number
        - -
        -
        - -

        destinyUserInfo

        -
        destinyUserInfo: IUserInfoCard
        - -
        -
        -

        Details about the player as they are known in game (platform display name, - Destiny emblem)

        -
        -
        -
        -
        - -

        emblemHash

        -
        emblemHash: number
        - -
        -
        -

        If we know the emblem's hash, this can be used to look up the player's emblem at - the time of a match when receiving PGCR data, or otherwise their currently - equipped emblem (if we are able to obtain it).

        -
        -
        -
        -
        - -

        genderHash

        -
        genderHash: number
        - -
        -
        - -

        lightLevel

        -
        lightLevel: number
        - -
        -
        -

        Light Level of the character if available. Zero if it is not available.

        -
        -
        -
        -
        - -

        raceHash

        -
        raceHash: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyplugruledefinition.html b/docs/interfaces/idestinyplugruledefinition.html deleted file mode 100644 index df598e5..0000000 --- a/docs/interfaces/idestinyplugruledefinition.html +++ /dev/null @@ -1,209 +0,0 @@ - - - - - - IDestinyPlugRuleDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPlugRuleDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Dictates a rule around whether the plug is enabled or insertable.

        -
        -

        In practice, the live Destiny data will refer to these entries by index. You can - then look up that index in the appropriate property (enabledRules or - insertionRules) to get the localized string for the failure message if it failed.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPlugRuleDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        failureMessage

        -
        failureMessage: string
        - -
        -
        -

        The localized string to show if this rule fails.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyplugsetdefinition.html b/docs/interfaces/idestinyplugsetdefinition.html deleted file mode 100644 index 8f65937..0000000 --- a/docs/interfaces/idestinyplugsetdefinition.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - IDestinyPlugSetDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPlugSetDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Sometimes, we have large sets of reusable plugs that are defined identically and - thus can (and in some cases, are so large that they must) be shared across the - places where they are used. These are the definitions for those reusable sets of - plugs.

        -
        -

        See DestinyItemSocketEntryDefinition.plugSource and reusablePlugSetHash for the - relationship between these reusable plug sets and the sockets that leverage them - (for starters, Emotes).

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPlugSetDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        -

        If you want to show these plugs in isolation, these are the display properties - for them.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        reusablePlugItems

        - - -
        -
        -

        This is a list of pre-determined plugs that can be plugged into this socket, - without the character having the plug in their inventory.

        -
        -

        If this list is populated, you will not be allowed to plug an arbitrary item in - the socket: you will only be able to choose from one of these reusable plugs.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyplugsetscomponent.html b/docs/interfaces/idestinyplugsetscomponent.html deleted file mode 100644 index 66dc541..0000000 --- a/docs/interfaces/idestinyplugsetscomponent.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - IDestinyPlugSetsComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPlugSetsComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Sockets may refer to a "Plug Set": a set of reusable plugs that may be shared - across multiple sockets (or even, in theory, multiple sockets over multiple - items).

        -
        -

        This is the set of those plugs that we came across in the users' inventory, - along with the values for plugs in the set. Any given set in this component may - be represented in Character and Profile-level, as some plugs may be Profile- - level restricted, and some character-level restricted. (note that the ones that - are even more specific will remain on the actual socket component itself, as - they cannot be reused)

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPlugSetsComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        plugs

        -
        plugs: object
        - -
        -
        -

        The shared list of plugs for each relevant PlugSet, keyed by the hash identifier - of the PlugSet (DestinyPlugSetDefinition).

        -
        -

        Mapped to IDestinyPlugSetDefinition in the manifest.

        -
        -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyplugwhitelistentrydefinition.html b/docs/interfaces/idestinyplugwhitelistentrydefinition.html deleted file mode 100644 index 9d7a98d..0000000 --- a/docs/interfaces/idestinyplugwhitelistentrydefinition.html +++ /dev/null @@ -1,262 +0,0 @@ - - - - - - IDestinyPlugWhitelistEntryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPlugWhitelistEntryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Defines a plug "Category" that is allowed to be plugged into a socket of this - type.

        -
        -

        This should be compared against a given plug item's - DestinyInventoryItemDefinition.plug.plugCategoryHash, which indicates the plug - item's category.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPlugWhitelistEntryDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        categoryHash

        -
        categoryHash: number
        - -
        -
        -

        The hash identifier of the Plug Category to compare against the plug item's plug. - plugCategoryHash.

        -
        -

        Note that this does NOT relate to any Definition in itself, it is only used for - comparison purposes.

        -
        -
        -
        - -

        categoryIdentifier

        -
        categoryIdentifier: string
        - -
        -
        -

        The string identifier for the category, which is here mostly for debug purposes.

        -
        -
        -
        -
        - -

        reinitializationPossiblePlugHashes

        -
        reinitializationPossiblePlugHashes: number[]
        - -
        -
        -

        The list of all plug items (DestinyInventoryItemDefinition) that the socket may - randomly be populated with when reinitialized.

        -
        -

        Which ones you should actually show are determined by the plug being inserted - into the socket, and the socket’s type.

        -

        When you inspect the plug that could go into a Masterwork Socket, look up the - socket type of the socket being inspected and find the - DestinySocketTypeDefinition.

        -

        Then, look at the Plugs that can fit in that socket. Find the Whitelist in the - DestinySocketTypeDefinition that matches the plug item’s categoryhash.

        -

        That whitelist entry will potentially have a new “ - reinitializationPossiblePlugHashes” property.If it does, that means we know what - it will roll if you try to insert this plug into this socket.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypositiondefinition.html b/docs/interfaces/idestinypositiondefinition.html deleted file mode 100644 index dcb69d6..0000000 --- a/docs/interfaces/idestinypositiondefinition.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IDestinyPositionDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPositionDefinition

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPositionDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        -
          -
        • x
        • -
        • y
        • -
        • z
        • -
        -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        x

        -
        x: number
        - -
        -
        - -

        y

        -
        y: number
        - -
        -
        - -

        z

        -
        z: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypostgamecarnagereportdata.html b/docs/interfaces/idestinypostgamecarnagereportdata.html deleted file mode 100644 index 842ed07..0000000 --- a/docs/interfaces/idestinypostgamecarnagereportdata.html +++ /dev/null @@ -1,276 +0,0 @@ - - - - - - IDestinyPostGameCarnageReportData | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPostGameCarnageReportData

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPostGameCarnageReportData -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activityDetails

        - - -
        -
        -

        Details about the activity.

        -
        -
        -
        -
        - -

        entries

        - - -
        -
        -

        Collection of players and their data for this activity.

        -
        -
        -
        -
        - -

        period

        -
        period: string
        - -
        -
        -

        Date and time for the activity.

        -
        -
        -
        -
        - -

        Optional startingPhaseIndex

        -
        startingPhaseIndex: number
        - -
        -
        -

        If this activity has "phases", this is the phase at which the activity was - started.

        -
        -
        -
        -
        - -

        teams

        - - -
        -
        -

        Collection of stats for the player in this activity.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypostgamecarnagereportentry.html b/docs/interfaces/idestinypostgamecarnagereportentry.html deleted file mode 100644 index e7717b2..0000000 --- a/docs/interfaces/idestinypostgamecarnagereportentry.html +++ /dev/null @@ -1,302 +0,0 @@ - - - - - - IDestinyPostGameCarnageReportEntry | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPostGameCarnageReportEntry

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPostGameCarnageReportEntry -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        characterId

        -
        characterId: string
        - -
        -
        -

        ID of the player's character used in the activity.

        -
        -
        -
        -
        - -

        extended

        - - -
        -
        -

        Extended data extracted from the activity blob.

        -
        -
        -
        -
        - -

        player

        - - -
        -
        -

        Identity details of the player

        -
        -
        -
        -
        - -

        score

        - - -
        -
        -

        Score of the player if available

        -
        -
        -
        -
        - -

        standing

        -
        standing: number
        - -
        -
        -

        Standing of the player

        -
        -
        -
        -
        - -

        values

        -
        values: object
        - -
        -
        -

        Collection of stats for the player in this activity.

        -
        -
        -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypostgamecarnagereportextendeddata.html b/docs/interfaces/idestinypostgamecarnagereportextendeddata.html deleted file mode 100644 index b09c7fa..0000000 --- a/docs/interfaces/idestinypostgamecarnagereportextendeddata.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - IDestinyPostGameCarnageReportExtendedData | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPostGameCarnageReportExtendedData

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPostGameCarnageReportExtendedData -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        values

        -
        values: object
        - -
        -
        -

        Collection of stats for the player in this activity.

        -
        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        weapons

        - - -
        -
        -

        List of weapons and their perspective values.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypostgamecarnagereportteamentry.html b/docs/interfaces/idestinypostgamecarnagereportteamentry.html deleted file mode 100644 index f824439..0000000 --- a/docs/interfaces/idestinypostgamecarnagereportteamentry.html +++ /dev/null @@ -1,256 +0,0 @@ - - - - - - IDestinyPostGameCarnageReportTeamEntry | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPostGameCarnageReportTeamEntry

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPostGameCarnageReportTeamEntry -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        score

        - - -
        -
        -

        Score earned by the team

        -
        -
        -
        -
        - -

        standing

        - - -
        -
        -

        Team's standing relative to other teams.

        -
        -
        -
        -
        - -

        teamId

        -
        teamId: number
        - -
        -
        -

        Integer ID for the team.

        -
        -
        -
        -
        - -

        teamName

        -
        teamName: string
        - -
        -
        -

        Alpha or Bravo

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypostmastertransferrequest.html b/docs/interfaces/idestinypostmastertransferrequest.html deleted file mode 100644 index 27be5a6..0000000 --- a/docs/interfaces/idestinypostmastertransferrequest.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - IDestinyPostmasterTransferRequest | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPostmasterTransferRequest

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPostmasterTransferRequest -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        characterId

        -
        characterId: string
        - -
        -
        - -

        itemId

        -
        itemId: string
        - -
        -
        - -

        itemReferenceHash

        -
        itemReferenceHash: number
        - -
        -
        - -

        membershipType

        -
        membershipType: BungieMembershipType
        - -
        -
        - -

        stackSize

        -
        stackSize: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypresentationchildblock.html b/docs/interfaces/idestinypresentationchildblock.html deleted file mode 100644 index 1aba179..0000000 --- a/docs/interfaces/idestinypresentationchildblock.html +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - IDestinyPresentationChildBlock | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPresentationChildBlock

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPresentationChildBlock -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        displayStyle

        - - -
        -
        - -

        parentPresentationNodeHashes

        -
        parentPresentationNodeHashes: number[]
        - -
        -
        -

        Mapped to IDestinyPresentationNodeDefinition in the manifest.

        -
        -
        -
        -
        - -

        presentationNodeType

        -
        presentationNodeType: DestinyPresentationNodeType
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypresentationnodechildentry.html b/docs/interfaces/idestinypresentationnodechildentry.html deleted file mode 100644 index 5c0eb78..0000000 --- a/docs/interfaces/idestinypresentationnodechildentry.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - IDestinyPresentationNodeChildEntry | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPresentationNodeChildEntry

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPresentationNodeChildEntry -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        presentationNodeHash

        -
        presentationNodeHash: number
        - -
        -
        -

        Mapped to IDestinyPresentationNodeDefinition in the manifest.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypresentationnodechildrenblock.html b/docs/interfaces/idestinypresentationnodechildrenblock.html deleted file mode 100644 index 5fbb6d5..0000000 --- a/docs/interfaces/idestinypresentationnodechildrenblock.html +++ /dev/null @@ -1,233 +0,0 @@ - - - - - - IDestinyPresentationNodeChildrenBlock | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPresentationNodeChildrenBlock

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        As/if presentation nodes begin to host more entities as children, these lists - will be added to. One list property exists per type of entity that can be - treated as a child of this presentation node, and each holds the identifier of - the entity and any associated information needed to display the UI for that - entity (if anything)

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPresentationNodeChildrenBlock -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        collectibles

        - - -
        -
        - -

        presentationNodes

        - - -
        -
        - -

        records

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypresentationnodecollectiblechildentry.html b/docs/interfaces/idestinypresentationnodecollectiblechildentry.html deleted file mode 100644 index 918c2ea..0000000 --- a/docs/interfaces/idestinypresentationnodecollectiblechildentry.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - IDestinyPresentationNodeCollectibleChildEntry | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPresentationNodeCollectibleChildEntry

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPresentationNodeCollectibleChildEntry -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        collectibleHash

        -
        collectibleHash: number
        - -
        -
        -

        Mapped to IDestinyCollectibleDefinition in the manifest.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypresentationnodecomponent.html b/docs/interfaces/idestinypresentationnodecomponent.html deleted file mode 100644 index cd1ca87..0000000 --- a/docs/interfaces/idestinypresentationnodecomponent.html +++ /dev/null @@ -1,255 +0,0 @@ - - - - - - IDestinyPresentationNodeComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPresentationNodeComponent

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPresentationNodeComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        completionValue

        -
        completionValue: number
        - -
        -
        -

        The value at which the presentation ode is considered to be completed.

        -
        -
        -
        -
        - -

        objective

        - - -
        -
        -

        An optional property: presentation nodes MAY have objectives, which can be used - to infer more human readable data about the progress. However, progressValue and - completionValue ought to be considered the canonical values for progress on - Progression Nodes.

        -
        -
        -
        -
        - -

        progressValue

        -
        progressValue: number
        - -
        -
        -

        How much of the presentation node is considered to be completed so far by the - given character/profile.

        -
        -
        -
        -
        - -

        state

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypresentationnodedefinition.html b/docs/interfaces/idestinypresentationnodedefinition.html deleted file mode 100644 index 16fd7cf..0000000 --- a/docs/interfaces/idestinypresentationnodedefinition.html +++ /dev/null @@ -1,514 +0,0 @@ - - - - - - IDestinyPresentationNodeDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPresentationNodeDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A PresentationNode is an entity that represents a logical grouping of other - entities visually/organizationally.

        -
        -

        For now, Presentation Nodes may contain the following... but it may be used for - more in the future:

        -
          -
        • Collectibles - Records (Or, as the public will call them, "Triumphs." Don't - ask me why we're overloading the term "Triumph", it still hurts me to think - about it) - Other Presentation Nodes, allowing a tree of Presentation Nodes to - be created
        • -
        -

        Part of me wants to break these into conceptual definitions per entity being - collected, but the possibility of these different types being mixed in the same - UI and the possibility that it could actually be more useful to return the "bare - metal" presentation node concept has resulted in me deciding against that for - the time being.

        -

        We'll see if I come to regret this as well.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPresentationNodeDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        children

        - - -
        -
        -

        The child entities contained by this presentation node.

        -
        -
        -
        -
        - -

        Optional completionRecordHash

        -
        completionRecordHash: number
        - -
        -
        -

        If this presentation node has an associated "Record" that you can accomplish for - completing its children, this is the identifier of that Record.

        -
        -

        Mapped to IDestinyRecordDefinition in the manifest.

        -
        -
        -
        - -

        disableChildSubscreenNavigation

        -
        disableChildSubscreenNavigation: boolean
        - -
        -
        -

        If this presentation node has children, but the game doesn't let you inspect the - details of those children, that is indicated here.

        -
        -
        -
        -
        - -

        displayProperties

        - - -
        -
        - -

        displayStyle

        - - -
        -
        -

        A hint for how to display this presentation node when it's shown in a list.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        nodeType

        - - -
        -
        - -

        Optional objectiveHash

        -
        objectiveHash: number
        - -
        -
        -

        If this presentation node shows a related objective (for instance, if it tracks - the progress of its children), the objective being tracked is indicated here.

        -
        -

        Mapped to IDestinyObjectiveDefinition in the manifest.

        -
        -
        -
        - -

        originalIcon

        -
        originalIcon: string
        - -
        -
        -

        The original icon for this presentation node, before we futzed with it.

        -
        -
        -
        -
        - -

        parentNodeHashes

        -
        parentNodeHashes: number[]
        - -
        -
        -

        A quick reference to presentation nodes that have this node as a child. ( - presentation nodes can be parented under multiple parents)

        -
        -

        Mapped to IDestinyPresentationNodeDefinition in the manifest.

        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        requirements

        - - -
        -
        -

        The requirements for being able to interact with this presentation node and its - children.

        -
        -
        -
        -
        - -

        rootViewIcon

        -
        rootViewIcon: string
        - -
        -
        -

        Some presentation nodes are meant to be explicitly shown on the "root" or "entry" - screens for the feature to which they are related. You should use this icon - when showing them on such a view, if you have a similar "entry point" view in - your UI. If you don't have a UI, then I guess it doesn't matter either way does - it?

        -
        -
        -
        -
        - -

        scope

        - - -
        -
        -

        Indicates whether this presentation node's state is determined on a per- - character or on an account-wide basis.

        -
        -
        -
        -
        - -

        screenStyle

        - - -
        -
        -

        A hint for how to display this presentation node when it's shown in its own - detail screen.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypresentationnoderecordchildentry.html b/docs/interfaces/idestinypresentationnoderecordchildentry.html deleted file mode 100644 index 5a35857..0000000 --- a/docs/interfaces/idestinypresentationnoderecordchildentry.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - IDestinyPresentationNodeRecordChildEntry | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPresentationNodeRecordChildEntry

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPresentationNodeRecordChildEntry -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        recordHash

        -
        recordHash: number
        - -
        -
        -

        Mapped to IDestinyRecordDefinition in the manifest.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypresentationnoderequirementsblock.html b/docs/interfaces/idestinypresentationnoderequirementsblock.html deleted file mode 100644 index e2dd144..0000000 --- a/docs/interfaces/idestinypresentationnoderequirementsblock.html +++ /dev/null @@ -1,209 +0,0 @@ - - - - - - IDestinyPresentationNodeRequirementsBlock | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPresentationNodeRequirementsBlock

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Presentation nodes can be restricted by various requirements. This defines the - rules of those requirements, and the message(s) to be shown if these - requirements aren't met.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPresentationNodeRequirementsBlock -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        entitlementUnavailableMessage

        -
        entitlementUnavailableMessage: string
        - -
        -
        -

        If this node is not accessible due to Entitlements (for instance, you don't own - the required game expansion), this is the message to show.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypresentationnodescomponent.html b/docs/interfaces/idestinypresentationnodescomponent.html deleted file mode 100644 index 2354f9b..0000000 --- a/docs/interfaces/idestinypresentationnodescomponent.html +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - IDestinyPresentationNodesComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPresentationNodesComponent

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPresentationNodesComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        nodes

        -
        nodes: object
        - -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyprofilecollectiblescomponent.html b/docs/interfaces/idestinyprofilecollectiblescomponent.html deleted file mode 100644 index 775c743..0000000 --- a/docs/interfaces/idestinyprofilecollectiblescomponent.html +++ /dev/null @@ -1,247 +0,0 @@ - - - - - - IDestinyProfileCollectiblesComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyProfileCollectiblesComponent

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyProfileCollectiblesComponent -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        collectibles

        -
        collectibles: object
        - -
        -

        Type declaration

        - -
        -
        -
        - -

        newnessFlaggedCollectibleHashes

        -
        newnessFlaggedCollectibleHashes: number[]
        - -
        -
        -

        The list of collectibles determined by the game as having been "recently" - acquired.

        -
        -

        The game client itself actually controls this data, so I personally question - whether anyone will get much use out of this: because we can't edit this value - through the API. But in case anyone finds it useful, here it is.

        -

        Mapped to IDestinyCollectibleDefinition in the manifest.

        -
        -
        -
        - -

        recentCollectibleHashes

        -
        recentCollectibleHashes: number[]
        - -
        -
        -

        The list of collectibles determined by the game as having been "recently" - acquired.

        -
        -

        Mapped to IDestinyCollectibleDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyprofilecomponent.html b/docs/interfaces/idestinyprofilecomponent.html deleted file mode 100644 index 555f476..0000000 --- a/docs/interfaces/idestinyprofilecomponent.html +++ /dev/null @@ -1,265 +0,0 @@ - - - - - - IDestinyProfileComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyProfileComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The most essential summary information about a Profile (in Destiny 1, we called - these "Accounts").

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyProfileComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        characterIds

        -
        characterIds: string[]
        - -
        -
        -

        A list of the character IDs, for further querying on your part.

        -
        -
        -
        -
        - -

        dateLastPlayed

        -
        dateLastPlayed: string
        - -
        -
        -

        The last time the user played with any character on this Profile.

        -
        -
        -
        -
        - -

        userInfo

        -
        userInfo: IUserInfoCard
        - -
        -
        -

        If you need to render the Profile (their platform name, icon, etc...) somewhere, - this property contains that information.

        -
        -
        -
        -
        - -

        versionsOwned

        -
        versionsOwned: DestinyGameVersions
        - -
        -
        -

        If you want to know what expansions they own, this will contain that data.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyprofileprogressioncomponent.html b/docs/interfaces/idestinyprofileprogressioncomponent.html deleted file mode 100644 index e26a43d..0000000 --- a/docs/interfaces/idestinyprofileprogressioncomponent.html +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - IDestinyProfileProgressionComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyProfileProgressionComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The set of progression-related information that applies at a Profile-wide level - for your Destiny experience. This differs from the Jimi Hendrix Experience - because there's less guitars on fire. Yet. #spoileralert?

        -
        -

        This will include information such as Checklist info.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyProfileProgressionComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        checklists

        -
        checklists: object
        - -
        -
        -

        The set of checklists that can be examined on a profile-wide basis, keyed by the - hash identifier of the Checklist (DestinyChecklistDefinition)

        -
        -

        For each checklist returned, its value is itself a Dictionary keyed by the - checklist's hash identifier with the value being a boolean indicating if it's - been discovered yet.

        -

        Mapped to IDestinyChecklistDefinition in the manifest.

        -
        -
        -

        Type declaration

        -
          -
        • -
          [key: number]: object
          -
            -
          • -
            [key: number]: boolean
            -
          • -
          -
        • -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyprofilerecordscomponent.html b/docs/interfaces/idestinyprofilerecordscomponent.html deleted file mode 100644 index 2524e9b..0000000 --- a/docs/interfaces/idestinyprofilerecordscomponent.html +++ /dev/null @@ -1,242 +0,0 @@ - - - - - - IDestinyProfileRecordsComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyProfileRecordsComponent

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyProfileRecordsComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        records

        -
        records: object
        - -
        -

        Type declaration

        - -
        -
        -
        - -

        score

        -
        score: number
        - -
        -
        -

        Your "Triumphs" score.

        -
        -
        -
        -
        - -

        Optional trackedRecordHash

        -
        trackedRecordHash: number
        - -
        -
        -

        If this profile is tracking a record, this is the hash identifier of the record - it is tracking.

        -
        -

        Mapped to IDestinyRecordDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyprofileresponse.html b/docs/interfaces/idestinyprofileresponse.html deleted file mode 100644 index 29f6e24..0000000 --- a/docs/interfaces/idestinyprofileresponse.html +++ /dev/null @@ -1,719 +0,0 @@ - - - - - - IDestinyProfileResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyProfileResponse

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The response for GetDestinyProfile, with components for character and item-level - data.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyProfileResponse -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        characterActivities

        - - -
        -
        -

        Character activity data - the activities available to this character and its - status, keyed by the Character's Id.

        -
        -

        COMPONENT TYPE: CharacterActivities

        -
        -
        -
        - -

        characterCollectibles

        - - -
        -
        -

        COMPONENT TYPE: Collectibles

        -
        -
        -
        -
        - -

        characterCurrencyLookups

        - - -
        -
        -

        A "lookup" convenience component that can be used to quickly check if the - character has access to items that can be used for purchasing.

        -
        -

        COMPONENT TYPE: CurrencyLookups

        -
        -
        -
        - -

        characterEquipment

        - - -
        -
        -

        The character's equipped items, keyed by the Character's Id.

        -
        -

        COMPONENT TYPE: CharacterEquipment

        -
        -
        -
        - -

        characterInventories

        - - -
        -
        -

        The character-level non-equipped inventory items, keyed by the Character's Id.

        -
        -

        COMPONENT TYPE: CharacterInventories

        -
        -
        -
        - -

        characterKiosks

        - - -
        -
        -

        Items available from Kiosks that are available to a specific character as - opposed to the account as a whole. It must be combined with data from the - profileKiosks property to get a full picture of the character's available items - to check out of a kiosk.

        -
        -

        This component returns information about what Kiosk items are available to you - on a Character level. Usually, kiosk items will be earned for the entire - Profile (all characters) at once. To find those, look in the profileKiosks - property.

        -

        COMPONENT TYPE: Kiosks

        -
        -
        -
        - -

        characterPlugSets

        - - -
        -
        -

        When sockets refer to reusable Plug Sets (see DestinyPlugSetDefinition for more - info), this is the set of plugs and their states, per character, that are - character-scoped.

        -
        -

        This comes back with ItemSockets, as it is needed for a complete picture of the - sockets on requested items.

        -

        COMPONENT TYPE: ItemSockets

        -
        -
        -
        - -

        characterPresentationNodes

        - - -
        -
        -

        COMPONENT TYPE: PresentationNodes

        -
        -
        -
        -
        - -

        characterProgressions

        - - -
        -
        -

        Character-level progression data, keyed by the Character's Id.

        -
        -

        COMPONENT TYPE: CharacterProgressions

        -
        -
        -
        - -

        characterRecords

        - - -
        -
        -

        COMPONENT TYPE: Records

        -
        -
        -
        -
        - -

        characterRenderData

        - - -
        -
        -

        Character rendering data - a minimal set of info needed to render a character in - 3D - keyed by the Character's Id.

        -
        -

        COMPONENT TYPE: CharacterRenderData

        -
        -
        -
        - -

        characterUninstancedItemComponents

        -
        characterUninstancedItemComponents: object
        - -
        -
        -

        Do you ever get the feeling that a system was designed too flexibly? That it - can be used in so many different ways that you end up being unable to provide an - easy to use abstraction for the mess that's happening under the surface?

        -
        -

        Let's talk about character-specific data that might be related to items without - instances. These two statements are totally unrelated, I promise.

        -

        At some point during D2, it was decided that items - such as Bounties - could be - given to characters and not have instance data, but that could display and - even use relevant state information on your account and character.

        -

        Up to now, any item that had meaningful dependencies on character or account - state had to be instanced, and thus "itemComponents" was all that you needed: it - was keyed by item's instance IDs and provided the stateful information you - needed inside.

        -

        Unfortunately, we don't live in such a magical world anymore. This is - information held on a per-character basis about non-instanced items that the - characters have in their inventory - or that reference character-specific state - information even if it's in Account-level inventory - and the values related to - that item's state in relation to the given character.

        -

        To give a concrete example, look at a Moments of Triumph bounty. They exist in a - character's inventory, and show/care about a character's progression toward - completing the bounty. But the bounty itself is a non-instanced item, like a mod - or a currency. This returns that data for the characters who have the bounty in - their inventory.

        -

        I'm not crying, you're crying Okay we're both crying but it's going to be okay I - promise Actually I shouldn't promise that, I don't know if it's going to be okay

        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        characters

        - - -
        -
        -

        Basic information about each character, keyed by the CharacterId.

        -
        -

        COMPONENT TYPE: Characters

        -
        -
        -
        - -

        itemComponents

        - - -
        -
        -

        Information about instanced items across all returned characters, keyed by the - item's instance ID.

        -
        -

        COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component - types.]

        -
        -
        -
        - -

        profile

        - - -
        -
        -

        The basic information about the Destiny Profile (formerly "Account").

        -
        -

        COMPONENT TYPE: Profiles

        -
        -
        -
        - -

        profileCollectibles

        - - -
        -
        -

        COMPONENT TYPE: Collectibles

        -
        -
        -
        -
        - -

        profileCurrencies

        - - -
        -
        -

        The profile-level currencies owned by the Destiny Profile.

        -
        -

        COMPONENT TYPE: ProfileCurrencies

        -
        -
        -
        - -

        profileInventory

        - - -
        -
        -

        The profile-level inventory of the Destiny Profile.

        -
        -

        COMPONENT TYPE: ProfileInventories

        -
        -
        -
        - -

        profileKiosks

        - - -
        -
        -

        Items available from Kiosks that are available Profile-wide (i.e. across all - characters)

        -
        -

        This component returns information about what Kiosk items are available to you - on a Profile level. It is theoretically possible for Kiosks to have items - gated by specific Character as well. If you ever have those, you will find them - on the characterKiosks property.

        -

        COMPONENT TYPE: Kiosks

        -
        -
        -
        - -

        profilePlugSets

        - - -
        -
        -

        When sockets refer to reusable Plug Sets (see DestinyPlugSetDefinition for more - info), this is the set of plugs and their states that are profile-scoped.

        -
        -

        This comes back with ItemSockets, as it is needed for a complete picture of the - sockets on requested items.

        -

        COMPONENT TYPE: ItemSockets

        -
        -
        -
        - -

        profilePresentationNodes

        - - -
        -
        -

        COMPONENT TYPE: PresentationNodes

        -
        -
        -
        -
        - -

        profileProgression

        - - -
        -
        -

        When we have progression information - such as Checklists - that may apply - profile-wide, it will be returned here rather than in the per-character - progression data.

        -
        -

        COMPONENT TYPE: ProfileProgression

        -
        -
        -
        - -

        profileRecords

        - - -
        -
        -

        COMPONENT TYPE: Records

        -
        -
        -
        -
        - -

        vendorReceipts

        - - -
        -
        -

        Recent, refundable purchases you have made from vendors. When will you use it? - Couldn't say...

        -
        -

        COMPONENT TYPE: VendorReceipts

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyprofileuserinfocard.html b/docs/interfaces/idestinyprofileuserinfocard.html deleted file mode 100644 index 87d7a52..0000000 --- a/docs/interfaces/idestinyprofileuserinfocard.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - IDestinyProfileUserInfoCard | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyProfileUserInfoCard

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyProfileUserInfoCard -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        dateLastPlayed

        -
        dateLastPlayed: string
        - -
        -
        - -

        displayName

        -
        displayName: string
        - -
        -
        -

        Display Name the player has chosen for themselves. The display name is optional - when the data type is used as input to a platform API.

        -
        -
        -
        -
        - -

        iconPath

        -
        iconPath: string
        - -
        -
        -

        URL the Icon if available.

        -
        -
        -
        -
        - -

        membershipId

        -
        membershipId: string
        - -
        -
        -

        Membership ID as they user is known in the Accounts service

        -
        -
        -
        -
        - -

        membershipType

        -
        membershipType: BungieMembershipType
        - -
        -
        -

        Type of the membership.

        -
        -
        -
        -
        - -

        supplementalDisplayName

        -
        supplementalDisplayName: string
        - -
        -
        -

        A platform specific additional display name - ex: psn Real Name, bnet Unique - Name, etc.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyprogression.html b/docs/interfaces/idestinyprogression.html deleted file mode 100644 index d94fe86..0000000 --- a/docs/interfaces/idestinyprogression.html +++ /dev/null @@ -1,410 +0,0 @@ - - - - - - IDestinyProgression | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyProgression

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Information about a current character's status with a Progression. A progression - is a value that can increase with activity and has levels. Think Character Level - and Reputation Levels. Combine this "live" data with the related - DestinyProgressionDefinition for a full picture of the Progression.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyProgression -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        currentProgress

        -
        currentProgress: number
        - -
        -
        -

        This is the total amount of progress obtained overall for this progression (for - instance, the total amount of Character Level experience earned)

        -
        -
        -
        -
        - -

        dailyLimit

        -
        dailyLimit: number
        - -
        -
        -

        If this progression has a daily limit, this is that limit.

        -
        -
        -
        -
        - -

        dailyProgress

        -
        dailyProgress: number
        - -
        -
        -

        The amount of progress earned today for this progression.

        -
        -
        -
        -
        - -

        level

        -
        level: number
        - -
        -
        -

        This is the level of the progression (for instance, the Character Level).

        -
        -
        -
        -
        - -

        levelCap

        -
        levelCap: number
        - -
        -
        -

        This is the maximum possible level you can achieve for this progression (for - example, the maximum character level obtainable)

        -
        -
        -
        -
        - -

        nextLevelAt

        -
        nextLevelAt: number
        - -
        -
        -

        The total amount of progression (i.e. "Experience") needed in order to reach the - next level.

        -
        -
        -
        -
        - -

        progressToNextLevel

        -
        progressToNextLevel: number
        - -
        -
        -

        The amount of progression (i.e. "Experience") needed to reach the next level of - this Progression. Jeez, progression is such an overloaded word.

        -
        -
        -
        -
        - -

        progressionHash

        -
        progressionHash: number
        - -
        -
        -

        The hash identifier of the Progression in question. Use it to look up the - DestinyProgressionDefinition in static data.

        -
        -

        Mapped to IDestinyProgressionDefinition in the manifest.

        -
        -
        -
        - -

        stepIndex

        -
        stepIndex: number
        - -
        -
        -

        Progressions define their levels in "steps". Since the last step may be - repeatable, the user may be at a higher level than the actual Step achieved in - the progression. Not necessarily useful, but potentially interesting for those - cruising the API. Relate this to the "steps" property of the DestinyProgression - to see which step the user is on, if you care about that. (Note that this is - Content Version dependent since it refers to indexes.)

        -
        -
        -
        -
        - -

        weeklyLimit

        -
        weeklyLimit: number
        - -
        -
        -

        If this progression has a weekly limit, this is that limit.

        -
        -
        -
        -
        - -

        weeklyProgress

        -
        weeklyProgress: number
        - -
        -
        -

        The amount of progress earned toward this progression in the current week.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyprogressiondefinition.html b/docs/interfaces/idestinyprogressiondefinition.html deleted file mode 100644 index c660008..0000000 --- a/docs/interfaces/idestinyprogressiondefinition.html +++ /dev/null @@ -1,451 +0,0 @@ - - - - - - IDestinyProgressionDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyProgressionDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A "Progression" in Destiny is best explained by an example.

        -
        -

        A Character's "Level" is a progression: it has Experience that can be earned, - levels that can be gained, and is evaluated and displayed at various points in - the game. A Character's "Faction Reputation" is also a progression for much the - same reason.

        -

        Progression is used by a variety of systems, and the definition of a Progression - will generally only be useful if combining with live data (such as a character's - DestinyCharacterProgressionComponent.progressions property, which holds that - character's live Progression states).

        -

        Fundamentally, a Progression measures your "Level" by evaluating the thresholds - in its Steps (one step per level, except for the last step which can be repeated - indefinitely for "Levels" that have no ceiling) against the total earned " - progression points"/experience. (for simplicity purposes, we will henceforth - refer to earned progression points as experience, though it need not be a - mechanic that in any way resembles Experience in a traditional sense).

        -

        Earned experience is calculated in a variety of ways, determined by the - Progression's scope. These go from looking up a stored value to performing - exceedingly obtuse calculations. This is why we provide live data in - DestinyCharacterProgressionComponent.progressions, so you don't have to worry - about those.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyProgressionDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        color

        - - -
        -
        -

        The #RGB string value for the color related to this progression, if there is one.

        -
        -
        -
        -
        - -

        displayProperties

        - - -
        -
        - -

        Optional factionHash

        -
        factionHash: number
        - -
        -
        -

        If the value exists, this is the hash identifier for the Faction that owns this - Progression.

        -
        -

        This is purely for convenience, if you're looking at a progression and want to - know if and who it's related to in terms of Faction Reputation.

        -

        Mapped to IDestinyFactionDefinition in the manifest.

        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        rankIcon

        -
        rankIcon: string
        - -
        -
        -

        For progressions that have it, this is the rank icon we use in the Companion, - displayed above the progressions' rank value.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        repeatLastStep

        -
        repeatLastStep: boolean
        - -
        -
        -

        If this is True, then the progression doesn't have a maximum level.

        -
        -
        -
        -
        - -

        scope

        - - -
        -
        -

        The "Scope" of the progression indicates the source of the progression's live - data.

        -
        -

        See the DestinyProgressionScope enum for more info: but essentially, a - Progression can either be backed by a stored value, or it can be a calculated - derivative of other values.

        -
        -
        -
        - -

        source

        -
        source: string
        - -
        -
        -

        If there's a description of how to earn this progression in the local config, - this will be that localized description.

        -
        -
        -
        -
        - -

        steps

        - - -
        -
        -

        Progressions are divided into Steps, which roughly equate to "Levels" in the - traditional sense of a Progression. Notably, the last step can be repeated - indefinitely if repeatLastStep is true, meaning that the calculation for your - level is not as simple as comparing your current progress to the max progress of - the steps.

        -
        -

        These and more calculations are done for you if you grab live character - progression data, such as in the DestinyCharacterProgressionComponent.

        -
        -
        -
        - -

        visible

        -
        visible: boolean
        - -
        -
        -

        If true, the Progression is something worth showing to users.

        -
        -

        If false, BNet isn't going to show it. But that doesn't mean you can't. We're - all friends here.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyprogressiondisplaypropertiesdefinition.html b/docs/interfaces/idestinyprogressiondisplaypropertiesdefinition.html deleted file mode 100644 index 85a9bfe..0000000 --- a/docs/interfaces/idestinyprogressiondisplaypropertiesdefinition.html +++ /dev/null @@ -1,266 +0,0 @@ - - - - - - IDestinyProgressionDisplayPropertiesDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyProgressionDisplayPropertiesDefinition

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyProgressionDisplayPropertiesDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        description

        -
        description: string
        - -
        -
        - -

        displayUnitsName

        -
        displayUnitsName: string
        - -
        -
        -

        When progressions show your "experience" gained, that bar has units (i.e. " - Experience", "Bad Dudes Snuffed Out", whatever). This is the localized string - for that unit of measurement.

        -
        -
        -
        -
        - -

        hasIcon

        -
        hasIcon: boolean
        - -
        -
        - -

        icon

        -
        icon: string
        - -
        -
        -

        Note that "icon" is sometimes misleading, and should be interpreted in the - context of the entity. For instance, in Destiny 1 the - DestinyRecordBookDefinition's icon was a big picture of a book.

        -
        -

        But usually, it will be a small square image that you can use as... well, an - icon.

        -
        -
        -
        - -

        name

        -
        name: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyprogressionlevelrequirementdefinition.html b/docs/interfaces/idestinyprogressionlevelrequirementdefinition.html deleted file mode 100644 index 8f0b1a8..0000000 --- a/docs/interfaces/idestinyprogressionlevelrequirementdefinition.html +++ /dev/null @@ -1,301 +0,0 @@ - - - - - - IDestinyProgressionLevelRequirementDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyProgressionLevelRequirementDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        These are pre-constructed collections of data that can be used to determine the - Level Requirement for an item given a Progression to be tested (such as the - Character's level).

        -
        -

        For instance, say a character receives a new Auto Rifle, and that Auto Rifle's - DestinyInventoryItemDefinition.quality.progressionLevelRequirementHash property - is pointing at one of these DestinyProgressionLevelRequirementDefinitions. Let's - pretend also that the progressionHash it is pointing at is the Character Level - progression. In that situation, the character's level will be used to - interpolate a value in the requirementCurve property. The value picked up from - that interpolation will be the required level for the item.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyProgressionLevelRequirementDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        progressionHash

        -
        progressionHash: number
        - -
        -
        -

        The progression whose level should be used to determine the level requirement.

        -
        -

        Look up the DestinyProgressionDefinition with this hash for more information - about the progression in question.

        -

        Mapped to IDestinyProgressionDefinition in the manifest.

        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        requirementCurve

        -
        requirementCurve: IInterpolationPointFloat[]
        - -
        -
        -

        A curve of level requirements, weighted by the related progressions' level.

        -
        -

        Interpolate against this curve with the character's progression level to - determine what the level requirement of the generated item that is using this - data will be.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyprogressionmappingdefinition.html b/docs/interfaces/idestinyprogressionmappingdefinition.html deleted file mode 100644 index 3b9bade..0000000 --- a/docs/interfaces/idestinyprogressionmappingdefinition.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - IDestinyProgressionMappingDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyProgressionMappingDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Aggregations of multiple progressions.

        -
        -

        These are used to apply rewards to multiple progressions at once. They can - sometimes have human readable data as well, but only extremely sporadically.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyProgressionMappingDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        -

        Infrequently defined in practice. Defer to the individual progressions' display - properties.

        -
        -
        -
        -
        - -

        displayUnits

        -
        displayUnits: string
        - -
        -
        -

        The localized unit of measurement for progression across the progressions - defined in this mapping. Unfortunately, this is very infrequently defined. Defer - to the individual progressions' display units.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyprogressionrewarddefinition.html b/docs/interfaces/idestinyprogressionrewarddefinition.html deleted file mode 100644 index 841d30c..0000000 --- a/docs/interfaces/idestinyprogressionrewarddefinition.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - - - IDestinyProgressionRewardDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyProgressionRewardDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Inventory Items can reward progression when actions are performed on them. A - common example of this in Destiny 1 was Bounties, which would reward Experience - on your Character and the like when you completed the bounty.

        -
        -

        Note that this maps to a DestinyProgressionMappingDefinition, and not a - DestinyProgressionDefinition directly. This is apparently so that multiple - progressions can be granted progression points/experience at the same time.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyProgressionRewardDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        amount

        -
        amount: number
        - -
        -
        -

        The amount of experience to give to each of the mapped progressions.

        -
        -
        -
        -
        - -

        applyThrottles

        -
        applyThrottles: boolean
        - -
        -
        -

        If true, the game's internal mechanisms to throttle progression should be - applied.

        -
        -
        -
        -
        - -

        progressionMappingHash

        -
        progressionMappingHash: number
        - -
        -
        -

        The hash identifier of the DestinyProgressionMappingDefinition that contains the - progressions for which experience should be applied.

        -
        -

        Mapped to IDestinyProgressionMappingDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyprogressionstepdefinition.html b/docs/interfaces/idestinyprogressionstepdefinition.html deleted file mode 100644 index 9948a91..0000000 --- a/docs/interfaces/idestinyprogressionstepdefinition.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - IDestinyProgressionStepDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyProgressionStepDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This defines a single Step in a progression (which roughly equates to a level. - See DestinyProgressionDefinition for caveats).

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyProgressionStepDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayEffectType

        - - -
        -
        -

        This appears to be, when you "level up", whether a visual effect will display - and on what entity. See DestinyProgressionStepDisplayEffect for slightly more - info.

        -
        -
        -
        -
        - -

        icon

        -
        icon: string
        - -
        -
        -

        If this progression step has a specific icon related to it, this is the icon to - show.

        -
        -
        -
        -
        - -

        progressTotal

        -
        progressTotal: number
        - -
        -
        -

        The total amount of progression points/"experience" you will need to initially - reach this step. If this is the last step and the progression is repeating - indefinitely (DestinyProgressionDefinition.repeatLastStep), this will also be - the progress needed to level it up further by repeating this step again.

        -
        -
        -
        -
        - -

        rewardItems

        -
        rewardItems: IDestinyItemQuantity[]
        - -
        -
        -

        A listing of items rewarded as a result of reaching this level.

        -
        -
        -
        -
        - -

        stepName

        -
        stepName: string
        - -
        -
        -

        Very rarely, Progressions will have localized text describing the Level of the - progression. This will be that localized text, if it exists. Otherwise, the - standard appears to be to simply show the level numerically.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypublicactivitystatus.html b/docs/interfaces/idestinypublicactivitystatus.html deleted file mode 100644 index a17674b..0000000 --- a/docs/interfaces/idestinypublicactivitystatus.html +++ /dev/null @@ -1,256 +0,0 @@ - - - - - - IDestinyPublicActivityStatus | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPublicActivityStatus

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents the public-facing status of an activity: any data about what is - currently active in the Activity, regardless of an individual character's - progress in it.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPublicActivityStatus -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        challengeObjectiveHashes

        -
        challengeObjectiveHashes: number[]
        - -
        -
        -

        Active Challenges for the activity, if any - represented as hashes for - DestinyObjectiveDefinitions.

        -
        -

        Mapped to IDestinyObjectiveDefinition in the manifest.

        -
        -
        -
        - -

        modifierHashes

        -
        modifierHashes: number[]
        - -
        -
        -

        The active modifiers on this activity, if any - represented as hashes for - DestinyActivityModifierDefinitions.

        -
        -

        Mapped to IDestinyActivityModifierDefinition in the manifest.

        -
        -
        -
        - -

        rewardTooltipItems

        -
        rewardTooltipItems: IDestinyItemQuantity[]
        - -
        -
        -

        If the activity itself provides any specific "mock" rewards, this will be the - items and their quantity.

        -
        -

        Why "mock", you ask? Because these are the rewards as they are represented in - the tooltip of the Activity.

        -

        These are often pointers to fake items that look good in a tooltip, but - represent an abstract concept of what you will get for a reward rather than the - specific items you may obtain.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypublicmilestone.html b/docs/interfaces/idestinypublicmilestone.html deleted file mode 100644 index b84ef04..0000000 --- a/docs/interfaces/idestinypublicmilestone.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - IDestinyPublicMilestone | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPublicMilestone

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Information about milestones, presented in a character state-agnostic manner. - Combine this data with DestinyMilestoneDefinition to get a full picture of the - milestone, which is basically a checklist of things to do in the game. Think of - this as GetPublicAdvisors 3.0, for those who used the Destiny 1 API.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPublicMilestone -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activities

        - - -
        -
        - -

        availableQuests

        -
        availableQuests: IDestinyPublicMilestoneQuest[]
        - -
        -
        -

        A milestone not need have even a single quest, but if there are active quests - they will be returned here.

        -
        -
        -
        -
        - -

        Optional endDate

        -
        endDate: string
        - -
        -
        -

        If known, this is the date when the Milestone will expire/recycle/end.

        -
        -
        -
        -
        - -

        milestoneHash

        -
        milestoneHash: number
        - -
        -
        -

        The hash identifier for the milestone. Use it to look up the - DestinyMilestoneDefinition for static data about the Milestone.

        -
        -

        Mapped to IDestinyMilestoneDefinition in the manifest.

        -
        -
        -
        - -

        order

        -
        order: number
        - -
        -
        -

        Used for ordering milestones in a display to match how we order them in BNet. - May pull from static data, or possibly in the future from dynamic information.

        -
        -
        -
        -
        - -

        Optional startDate

        -
        startDate: string
        - -
        -
        -

        If known, this is the date when the Milestone started/became active.

        -
        -
        -
        -
        - -

        vendorHashes

        -
        vendorHashes: number[]
        - -
        -
        -

        Sometimes milestones - or activities active in milestones - will have relevant - vendors. These are the vendors that are currently relevant.

        -
        -

        Deprecated, already, for the sake of the new "vendors" property that has more - data. What was I thinking.

        -
        -
        -
        - -

        vendors

        - - -
        -
        -

        This is why we can't have nice things. This is the ordered list of vendors to be - shown that relate to this milestone, potentially along with other interesting - data.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypublicmilestoneactivity.html b/docs/interfaces/idestinypublicmilestoneactivity.html deleted file mode 100644 index 20f9271..0000000 --- a/docs/interfaces/idestinypublicmilestoneactivity.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - IDestinyPublicMilestoneActivity | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPublicMilestoneActivity

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A milestone may have one or more conceptual Activities associated with it, and - each of those conceptual activities could have a variety of variants, modes, - tiers, what-have-you. Our attempts to determine what qualifies as a conceptual - activity are, unfortunately, janky. So if you see missing modes or modes that - don't seem appropriate to you, let us know and I'll buy you a beer if we ever - meet up in person.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPublicMilestoneActivity -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activityHash

        -
        activityHash: number
        - -
        -
        -

        The hash identifier of the activity that's been chosen to be considered the - canonical "conceptual" activity definition. This may have many variants, defined - herein.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        Optional activityModeHash

        -
        activityModeHash: number
        - -
        -
        -

        The hash identifier of the most specific Activity Mode under which this activity - is played. This is useful for situations where the activity in question is - for - instance - a PVP map, but it's not clear what mode the PVP map is being played - under. If it's a playlist, this will be less specific: but hopefully useful in - some way.

        -
        -

        Mapped to IDestinyActivityModeDefinition in the manifest.

        -
        -
        -
        - -

        Optional activityModeType

        -
        activityModeType: number
        - -
        -
        -

        The enumeration equivalent of the most specific Activity Mode under which this - activity is played.

        -
        -
        -
        -
        - -

        modifierHashes

        -
        modifierHashes: number[]
        - -
        -
        -

        The activity may have 0-to-many modifiers: if it does, this will contain the - hashes to the DestinyActivityModifierDefinition that defines the modifier being - applied.

        -
        -

        Mapped to IDestinyActivityModifierDefinition in the manifest.

        -
        -
        -
        - -

        variants

        - - -
        -
        -

        Every relevant variation of this conceptual activity, including the conceptual - activity itself, have variants defined here.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypublicmilestoneactivityvariant.html b/docs/interfaces/idestinypublicmilestoneactivityvariant.html deleted file mode 100644 index bfb4a6c..0000000 --- a/docs/interfaces/idestinypublicmilestoneactivityvariant.html +++ /dev/null @@ -1,253 +0,0 @@ - - - - - - IDestinyPublicMilestoneActivityVariant | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPublicMilestoneActivityVariant

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents a variant of an activity that's relevant to a milestone.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPublicMilestoneActivityVariant -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activityHash

        -
        activityHash: number
        - -
        -
        -

        The hash identifier of this activity variant. Examine the activity's definition - in the Manifest database to determine what makes it a distinct variant. Usually - it will be difficulty level or whether or not it is a guided game variant of the - activity, but theoretically it could be distinguished in any arbitrary way.

        -
        -
        -
        -
        - -

        Optional activityModeHash

        -
        activityModeHash: number
        - -
        -
        -

        The hash identifier of the most specific Activity Mode under which this activity - is played. This is useful for situations where the activity in question is - for - instance - a PVP map, but it's not clear what mode the PVP map is being played - under. If it's a playlist, this will be less specific: but hopefully useful in - some way.

        -
        -

        Mapped to IDestinyActivityModeDefinition in the manifest.

        -
        -
        -
        - -

        Optional activityModeType

        -
        activityModeType: number
        - -
        -
        -

        The enumeration equivalent of the most specific Activity Mode under which this - activity is played.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypublicmilestonechallenge.html b/docs/interfaces/idestinypublicmilestonechallenge.html deleted file mode 100644 index 3873579..0000000 --- a/docs/interfaces/idestinypublicmilestonechallenge.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - - IDestinyPublicMilestoneChallenge | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPublicMilestoneChallenge

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A Milestone can have many Challenges. Challenges are just extra Objectives that - provide a fun way to mix-up play and provide extra rewards.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPublicMilestoneChallenge -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        Optional activityHash

        -
        activityHash: number
        - -
        -
        -

        IF the Objective is related to a specific Activity, this will be that activity's - hash. Use it to look up the DestinyActivityDefinition for additional data to - show.

        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        - -

        objectiveHash

        -
        objectiveHash: number
        - -
        -
        -

        The objective for the Challenge, which should have human-readable data about - what needs to be done to accomplish the objective. Use this hash to look up the - DestinyObjectiveDefinition.

        -
        -

        Mapped to IDestinyObjectiveDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypublicmilestonechallengeactivity.html b/docs/interfaces/idestinypublicmilestonechallengeactivity.html deleted file mode 100644 index f9086fa..0000000 --- a/docs/interfaces/idestinypublicmilestonechallengeactivity.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - - IDestinyPublicMilestoneChallengeActivity | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPublicMilestoneChallengeActivity

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPublicMilestoneChallengeActivity -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activityHash

        -
        activityHash: number
        - -
        -
        -

        Mapped to IDestinyActivityDefinition in the manifest.

        -
        -
        -
        -
        - -

        booleanActivityOptions

        -
        booleanActivityOptions: object
        - -
        -
        -

        The set of activity options for this activity, keyed by an identifier that's - unique for this activity (not guaranteed to be unique between or across all - activities, though should be unique for every variant of a given conceptual - activity: for instance, the original D2 Raid has many variant - DestinyActivityDefinitions. While other activities could potentially have the - same option hashes, for any given D2 base Raid variant the hash will be unique).

        -
        -

        As a concrete example of this data, the hashes you get for Raids will correspond - to the currently active "Challenge Mode".

        -

        We have no human readable information for this data, so it's up to you if you - want to associate it with such info to show it.

        -
        -
        -

        Type declaration

        -
          -
        • -
          [key: number]: boolean
          -
        • -
        -
        -
        -
        - -

        challengeObjectiveHashes

        -
        challengeObjectiveHashes: number[]
        - -
        -
        - -

        Optional loadoutRequirementIndex

        -
        loadoutRequirementIndex: number
        - -
        -
        -

        If returned, this is the index into the DestinyActivityDefinition's "loadouts" - property, indicating the currently active loadout requirements.

        -
        -
        -
        -
        - -

        modifierHashes

        -
        modifierHashes: number[]
        - -
        -
        -

        If the activity has modifiers, this will be the list of modifiers that all - variants have in common. Perform lookups against - DestinyActivityModifierDefinition which defines the modifier being applied to - get at the modifier data.

        -
        -

        Note that, in the DestiyActivityDefinition, you will see many more modifiers - than this being referred to: those are all possible modifiers for the activity, - not the active ones. Use only the active ones to match what's really live.

        -

        Mapped to IDestinyActivityModifierDefinition in the manifest.

        -
        -
        -
        - -

        phaseHashes

        -
        phaseHashes: number[]
        - -
        -
        -

        The ordered list of phases for this activity, if any. Note that we have no human - readable info for phases, nor any entities to relate them to: relating these - hashes to something human readable is up to you unfortunately.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypublicmilestonequest.html b/docs/interfaces/idestinypublicmilestonequest.html deleted file mode 100644 index 89536ed..0000000 --- a/docs/interfaces/idestinypublicmilestonequest.html +++ /dev/null @@ -1,246 +0,0 @@ - - - - - - IDestinyPublicMilestoneQuest | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPublicMilestoneQuest

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPublicMilestoneQuest -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activity

        - - -
        -
        -

        A milestone need not have an active activity, but if there is one it will be - returned here, along with any variant and additional information.

        -
        -
        -
        -
        - -

        challenges

        - - -
        -
        -

        For the given quest there could be 0-to-Many challenges: mini quests that you - can perform in the course of doing this quest, that may grant you rewards and - benefits.

        -
        -
        -
        -
        - -

        questItemHash

        -
        questItemHash: number
        - -
        -
        -

        Quests are defined as Items in content. As such, this is the hash identifier of - the DestinyInventoryItemDefinition that represents this quest. It will have - pointers to all of the steps in the quest, and display information for the quest - (title, description, icon etc) Individual steps will be referred to in the Quest - item's DestinyInventoryItemDefinition.setData property, and themselves are Items - with their own renderable data.

        -
        -

        Mapped to IDestinyMilestoneDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinypublicmilestonevendor.html b/docs/interfaces/idestinypublicmilestonevendor.html deleted file mode 100644 index 4a83337..0000000 --- a/docs/interfaces/idestinypublicmilestonevendor.html +++ /dev/null @@ -1,225 +0,0 @@ - - - - - - IDestinyPublicMilestoneVendor | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyPublicMilestoneVendor

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyPublicMilestoneVendor -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        Optional previewItemHash

        -
        previewItemHash: number
        - -
        -
        -

        If this vendor is featuring a specific item for this event, this will be the - hash identifier of that item. I'm taking bets now on how long we go before this - needs to be a list or some other, more complex representation instead and I - deprecate this too. I'm going to go with 5 months. Calling it now, 2017-09-14 at - 9:46pm PST.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        vendorHash

        -
        vendorHash: number
        - -
        -
        -

        The hash identifier of the Vendor related to this Milestone. You can show useful - things from this, such as thier Faction icon or whatever you might care about.

        -
        -

        Mapped to IDestinyVendorDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyqueststatus.html b/docs/interfaces/idestinyqueststatus.html deleted file mode 100644 index 09d29af..0000000 --- a/docs/interfaces/idestinyqueststatus.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - IDestinyQuestStatus | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyQuestStatus

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Data regarding the progress of a Quest for a specific character. Quests are - composed of multiple steps, each with potentially multiple objectives: this - QuestStatus will return Objective data for the currently active step in this - quest.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyQuestStatus -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        completed

        -
        completed: boolean
        - -
        -
        -

        Whether or not the whole quest has been completed, regardless of whether or not - you have redeemed the rewards for the quest.

        -
        -
        -
        -
        - -

        itemInstanceId

        -
        itemInstanceId: string
        - -
        -
        -

        The current Quest Step will be an instanced item in the player's inventory. If - you care about that, this is the instance ID of that item.

        -
        -
        -
        -
        - -

        questHash

        -
        questHash: number
        - -
        -
        -

        The hash identifier for the Quest Item. (Note: Quests are defined as Items, and - thus you would use this to look up the quest's DestinyInventoryItemDefinition). - For information on all steps in the quest, you can then examine its - DestinyInventoryItemDefinition.setData property for Quest Steps (which are also - items). You can use the Item Definition to display human readable data about - the overall quest.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        redeemed

        -
        redeemed: boolean
        - -
        -
        -

        Whether or not you have redeemed rewards for this quest.

        -
        -
        -
        -
        - -

        started

        -
        started: boolean
        - -
        -
        -

        Whether or not you have started this quest.

        -
        -
        -
        -
        - -

        stepHash

        -
        stepHash: number
        - -
        -
        -

        The hash identifier of the current Quest Step, which is also a - DestinyInventoryItemDefinition. You can use this to get human readable data - about the current step and what to do in that step.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        stepObjectives

        -
        stepObjectives: IDestinyObjectiveProgress[]
        - -
        -
        -

        A step can have multiple objectives. This will give you the progress for each - objective in the current step, in the order in which they are rendered in-game.

        -
        -
        -
        -
        - -

        tracked

        -
        tracked: boolean
        - -
        -
        -

        Whether or not the quest is tracked

        -
        -
        -
        -
        - -

        Optional vendorHash

        -
        vendorHash: number
        - -
        -
        -

        If the quest has a related Vendor that you should talk to in order to initiate - the quest/earn rewards/continue the quest, this will be the hash identifier of - that Vendor. Look it up its DestinyVendorDefinition.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyracedefinition.html b/docs/interfaces/idestinyracedefinition.html deleted file mode 100644 index 43e6ba2..0000000 --- a/docs/interfaces/idestinyracedefinition.html +++ /dev/null @@ -1,340 +0,0 @@ - - - - - - IDestinyRaceDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyRaceDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        In Destiny, "Races" are really more like "Species". Sort of. I mean, are the - Awoken a separate species from humans? I'm not sure. But either way, they're - defined here. You'll see Exo, Awoken, and Human as examples of these Species. - Players will choose one for their character.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyRaceDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        - -

        genderedRaceNames

        -
        genderedRaceNames: object
        - -
        -
        -

        A localized string referring to the singular form of the Race's name when - referred to in gendered form. Keyed by the DestinyGender.

        -
        -
        -
        -

        Type declaration

        -
          -
        • -
          [key: number]: string
          -
        • -
        -
        -
        -
        - -

        genderedRaceNamesByGenderHash

        -
        genderedRaceNamesByGenderHash: object
        - -
        -
        -

        Mapped to IDestinyGenderDefinition in the manifest.

        -
        -
        -
        -

        Type declaration

        -
          -
        • -
          [key: number]: string
          -
        • -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        raceType

        -
        raceType: DestinyRace
        - -
        -
        -

        An enumeration defining the existing, known Races/Species for player characters. - This value will be the enum value matching this definition.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyrecordcompletionblock.html b/docs/interfaces/idestinyrecordcompletionblock.html deleted file mode 100644 index 9d06369..0000000 --- a/docs/interfaces/idestinyrecordcompletionblock.html +++ /dev/null @@ -1,242 +0,0 @@ - - - - - - IDestinyRecordCompletionBlock | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyRecordCompletionBlock

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyRecordCompletionBlock -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        ScoreValue

        -
        ScoreValue: number
        - -
        -
        - -

        partialCompletionObjectiveCountThreshold

        -
        partialCompletionObjectiveCountThreshold: number
        - -
        -
        -

        The number of objectives that must be completed before the objective is - considered "complete"

        -
        -
        -
        -
        - -

        shouldFireToast

        -
        shouldFireToast: boolean
        - -
        -
        - -

        toastStyle

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyrecordcomponent.html b/docs/interfaces/idestinyrecordcomponent.html deleted file mode 100644 index 2e76cff..0000000 --- a/docs/interfaces/idestinyrecordcomponent.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IDestinyRecordComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyRecordComponent

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyRecordComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        objectives

        - - -
        -
        - -

        state

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyrecorddefinition.html b/docs/interfaces/idestinyrecorddefinition.html deleted file mode 100644 index 166c451..0000000 --- a/docs/interfaces/idestinyrecorddefinition.html +++ /dev/null @@ -1,397 +0,0 @@ - - - - - - IDestinyRecordDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyRecordDefinition

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyRecordDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        completionInfo

        - - -
        -
        - -

        displayProperties

        - - -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        Optional loreHash

        -
        loreHash: number
        - -
        -
        -

        Mapped to IDestinyLoreDefinition in the manifest.

        -
        -
        -
        -
        - -

        objectiveHashes

        -
        objectiveHashes: number[]
        - -
        -
        -

        Mapped to IDestinyObjectiveDefinition in the manifest.

        -
        -
        -
        -
        - -

        presentationInfo

        - - -
        -
        - -

        recordValueStyle

        -
        recordValueStyle: DestinyRecordValueStyle
        - -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        requirements

        - - -
        -
        - -

        scope

        - - -
        -
        -

        Indicates whether this Record's state is determined on a per-character or on an - account-wide basis.

        -
        -
        -
        -
        - -

        stateInfo

        - - -
        -
        - -

        titleInfo

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyrecordtitleblock.html b/docs/interfaces/idestinyrecordtitleblock.html deleted file mode 100644 index fa4fe00..0000000 --- a/docs/interfaces/idestinyrecordtitleblock.html +++ /dev/null @@ -1,244 +0,0 @@ - - - - - - IDestinyRecordTitleBlock | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyRecordTitleBlock

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyRecordTitleBlock -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        hasTitle

        -
        hasTitle: boolean
        - -
        -
        - -

        titlesByGender

        -
        titlesByGender: object
        - -
        -

        Type declaration

        -
          -
        • -
          [key: number]: string
          -
        • -
        -
        -
        -
        - -

        titlesByGenderHash

        -
        titlesByGenderHash: object
        - -
        -
        -

        For those who prefer to use the definitions.

        -
        -

        Mapped to IDestinyGenderDefinition in the manifest.

        -
        -
        -

        Type declaration

        -
          -
        • -
          [key: number]: string
          -
        • -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyreportoffensepgcrrequest.html b/docs/interfaces/idestinyreportoffensepgcrrequest.html deleted file mode 100644 index 946e404..0000000 --- a/docs/interfaces/idestinyreportoffensepgcrrequest.html +++ /dev/null @@ -1,262 +0,0 @@ - - - - - - IDestinyReportOffensePgcrRequest | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyReportOffensePgcrRequest

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If you want to report a player causing trouble in a game, this request will let - you report that player and the specific PGCR in which the trouble was caused, - along with why.

        -
        -

        Please don't do this just because you dislike the person! I mean, I know people - will do it anyways, but can you like take a good walk, or put a curse on them or - something? Do me a solid and reconsider.

        -

        Note that this request object doesn't have the actual PGCR ID nor your Account/ - Character ID in it. We will infer that information from your authentication - information and the PGCR ID that you pass into the URL of the reporting endpoint - itself.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyReportOffensePgcrRequest -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        offendingCharacterId

        -
        offendingCharacterId: string
        - -
        -
        -

        Within the PGCR provided when calling the Reporting endpoint, this should be the - character ID of the user that you thought was violating terms of use. They must - exist in the PGCR provided.

        -
        -
        -
        -
        - -

        reasonCategoryHashes

        -
        reasonCategoryHashes: number[]
        - -
        -
        -

        So you've decided to report someone instead of cursing them and their - descendants. Well, okay then. This is the category or categorie(s) of - infractions for which you are reporting the user. These are hash identifiers - that map to DestinyReportReasonCategoryDefinition entries.

        -
        -

        Mapped to IDestinyReportReasonCategoryDefinition in the manifest.

        -
        -
        -
        - -

        reasonHashes

        -
        reasonHashes: number[]
        - -
        -
        -

        If applicable, provide a more specific reason(s) within the general category of - problems provided by the reasonHash. This is also an identifier for a reason. - All reasonHashes provided must be children of at least one the - reasonCategoryHashes provided.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyreportreasoncategorydefinition.html b/docs/interfaces/idestinyreportreasoncategorydefinition.html deleted file mode 100644 index 2ae39fa..0000000 --- a/docs/interfaces/idestinyreportreasoncategorydefinition.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - IDestinyReportReasonCategoryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyReportReasonCategoryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If you're going to report someone for a Terms of Service violation, you need to - choose a category and reason for the report. This definition holds both the - categories and the reasons within those categories, for simplicity and my own - laziness' sake.

        -
        -

        Note tha this means that, to refer to a Reason by reasonHash, you need a - combination of the reasonHash and the associated ReasonCategory's hash: there - are some reasons defined under multiple categories.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyReportReasonCategoryDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        reasons

        -
        reasons: object
        - -
        -
        -

        The specific reasons for the report under this category.

        -
        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyreportreasondefinition.html b/docs/interfaces/idestinyreportreasondefinition.html deleted file mode 100644 index 3435a27..0000000 --- a/docs/interfaces/idestinyreportreasondefinition.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - IDestinyReportReasonDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyReportReasonDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A specific reason for being banned. Only accessible under the related category ( - DestinyReportReasonCategoryDefinition) under which it is shown. Note that this - means that report reasons' reasonHash are not globally unique: and indeed, - entries like "Other" are defined under most categories for example.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyReportReasonDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        - -

        reasonHash

        -
        reasonHash: number
        - -
        -
        -

        The identifier for the reason: they are only guaranteed unique under the - Category in which they are found.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyrewardsourcedefinition.html b/docs/interfaces/idestinyrewardsourcedefinition.html deleted file mode 100644 index bd6f1e2..0000000 --- a/docs/interfaces/idestinyrewardsourcedefinition.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - IDestinyRewardSourceDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyRewardSourceDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents a heuristically-determined "item source" according to Bungie.net. - These item sources are non-canonical: we apply a combination of special - configuration and often-fragile heuristics to attempt to discern whether an item - should be part of a given "source," but we have known cases of false positives - and negatives due to our imperfect heuristics.

        -
        -

        Still, they provide a decent approximation for people trying to figure out how - an item can be obtained. DestinyInventoryItemDefinition refers to sources in the - sourceDatas.sourceHashes property for all sources we determined the item could - spawn from.

        -

        An example in Destiny 1 of a Source would be "Nightfall". If an item has the " - Nightfall" source associated with it, it's extremely likely that you can earn - that item while playing Nightfall, either during play or as an after-completion - reward.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyRewardSourceDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        category

        - - -
        -
        -

        Sources are grouped into categories: common ways that items are provided. I hope - to see this expand in Destiny 2 once we have time to generate accurate reward - source data.

        -
        -
        -
        -
        - -

        displayProperties

        - - -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinysandboxperkdefinition.html b/docs/interfaces/idestinysandboxperkdefinition.html deleted file mode 100644 index b2af2c8..0000000 --- a/docs/interfaces/idestinysandboxperkdefinition.html +++ /dev/null @@ -1,391 +0,0 @@ - - - - - - IDestinySandboxPerkDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinySandboxPerkDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Perks are modifiers to a character or item that can be applied situationally.

        -
        -
          -
        • Perks determine a weapons' damage type.

          -
        • -
        • Perks put the Mods in Modifiers (they are literally the entity that bestows - the Sandbox benefit for whatever fluff text about the modifier in the Socket, - Plug or Talent Node)

          -
        • -
        • Perks are applied for unique alterations of state in Objectives

          -
        • -
        -

        Anyways, I'm sure you can see why perks are so interesting.

        -

        What Perks often don't have is human readable information, so we attempt to - reverse engineer that by pulling that data from places that uniquely refer to - these perks: namely, Talent Nodes and Plugs. That only gives us a subset of - perks that are human readable, but those perks are the ones people generally - care about anyways. The others are left as a mystery, their true purpose mostly - unknown and undocumented.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinySandboxPerkDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        damageType

        -
        damageType: DamageType
        - -
        -
        -

        If this perk grants a damage type to a weapon, the damage type will be defined - here.

        -
        -

        Unless you have a compelling reason to use this enum value, use the - damageTypeHash instead to look up the actual DestinyDamageTypeDefinition.

        -
        -
        -
        - -

        Optional damageTypeHash

        -
        damageTypeHash: number
        - -
        -
        -

        The hash identifier for looking up the DestinyDamageTypeDefinition, if this perk - has a damage type.

        -
        -

        This is preferred over using the damageType enumeration value, which has been - left purely because it is occasionally convenient.

        -
        -
        -
        - -

        displayProperties

        - - -
        -
        -

        These display properties are by no means guaranteed to be populated. Usually - when it is, it's only because we back-filled them with the displayProperties of - some Talent Node or Plug item that happened to be uniquely providing that perk.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        isDisplayable

        -
        isDisplayable: boolean
        - -
        -
        -

        If true, you can actually show the perk in the UI. Otherwise, it doesn't have - useful player-facing information.

        -
        -
        -
        -
        - -

        perkGroups

        - - -
        -
        -

        An old holdover from the original Armory, this was an attempt to group perks by - functionality.

        -
        -

        It is as yet unpopulated, and there will be quite a bit of work needed to - restore it to its former working order.

        -
        -
        -
        - -

        perkIdentifier

        -
        perkIdentifier: string
        - -
        -
        -

        The string identifier for the perk.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinysocketcategorydefinition.html b/docs/interfaces/idestinysocketcategorydefinition.html deleted file mode 100644 index b446506..0000000 --- a/docs/interfaces/idestinysocketcategorydefinition.html +++ /dev/null @@ -1,318 +0,0 @@ - - - - - - IDestinySocketCategoryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinySocketCategoryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Sockets on an item are organized into Categories visually.

        -
        -

        You can find references to the socket category defined on an item's - DestinyInventoryItemDefinition.sockets.socketCategories property.

        -

        This has the display information for rendering the categories' header, and a - hint for how the UI should handle showing this category.

        -

        The shitty thing about this, however, is that the socket categories' UI style - can be overridden by the item's UI style. For instance, the Socket Category used - by Emote Sockets says it's "consumable," but that's a lie: they're all reusable, - and overridden by the detail UI pages in ways that we can't easily account for - in the API.

        -

        As a result, I will try to compile these rules into the individual sockets on - items, and provide the best hint possible there through the plugSources property. - In the future, I may attempt to use this information in conjunction with the - item to provide a more usable UI hint on the socket layer, but for now improving - the consistency of plugSources is the best I have time to provide. (See https:// - github.com/Bungie-net/api/issues/522 for more info)

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinySocketCategoryDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        categoryStyle

        - - -
        -
        -

        Same as uiCategoryStyle, but in a more usable enumeration form.

        -
        -
        -
        -
        - -

        displayProperties

        - - -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        uiCategoryStyle

        -
        uiCategoryStyle: number
        - -
        -
        -

        A string hinting to the game's UI system about how the sockets in this category - should be displayed.

        -
        -

        BNet doesn't use it: it's up to you to find valid values and make your own - special UI if you want to honor this category style.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinysockettypedefinition.html b/docs/interfaces/idestinysockettypedefinition.html deleted file mode 100644 index a9fea8a..0000000 --- a/docs/interfaces/idestinysockettypedefinition.html +++ /dev/null @@ -1,449 +0,0 @@ - - - - - - IDestinySocketTypeDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinySocketTypeDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        All Sockets have a "Type": a set of common properties that determine when the - socket allows Plugs to be inserted, what Categories of Plugs can be inserted, - and whether the socket is even visible at all given the current game/character/ - account state.

        -
        -

        See DestinyInventoryItemDefinition for more information about Socketed items and - Plugs.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinySocketTypeDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        alwaysRandomizeSockets

        -
        alwaysRandomizeSockets: boolean
        - -
        -
        - -

        avoidDuplicatesOnInitialization

        -
        avoidDuplicatesOnInitialization: boolean
        - -
        -
        - -

        currencyScalars

        - - -
        -
        - -

        displayProperties

        - - -
        -
        -

        There are fields for this display data, but they appear to be unpopulated as of - now. I am not sure where in the UI these would show if they even were populated, - but I will continue to return this data in case it becomes useful.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        hideDuplicateReusablePlugs

        -
        hideDuplicateReusablePlugs: boolean
        - -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        insertAction

        - - -
        -
        -

        Defines what happens when a plug is inserted into sockets of this type.

        -
        -
        -
        -
        - -

        isPreviewEnabled

        -
        isPreviewEnabled: boolean
        - -
        -
        - -

        overridesUiAppearance

        -
        overridesUiAppearance: boolean
        - -
        -
        -

        This property indicates if the socket type determines whether Emblem icons and - nameplates should be overridden by the inserted plug item's icon and nameplate.

        -
        -
        -
        -
        - -

        plugWhitelist

        - - -
        -
        -

        A list of Plug "Categories" that are allowed to be plugged into sockets of this - type.

        -
        -

        These should be compared against a given plug item's - DestinyInventoryItemDefinition.plug.plugCategoryHash, which indicates the plug - item's category.

        -

        If the plug's category matches any whitelisted plug, or if the whitelist is - empty, it is allowed to be inserted.

        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        socketCategoryHash

        -
        socketCategoryHash: number
        - -
        -
        -

        Mapped to IDestinySocketCategoryDefinition in the manifest.

        -
        -
        -
        -
        - -

        visibility

        - - -
        -
        -

        Sometimes a socket isn't visible. These are some of the conditions under which - sockets of this type are not visible. Unfortunately, the truth of visibility is - much, much more complex. Best to rely on the live data for whether the socket is - visible and enabled.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinysockettypescalarmaterialrequiremententry.html b/docs/interfaces/idestinysockettypescalarmaterialrequiremententry.html deleted file mode 100644 index 542ddc8..0000000 --- a/docs/interfaces/idestinysockettypescalarmaterialrequiremententry.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IDestinySocketTypeScalarMaterialRequirementEntry | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinySocketTypeScalarMaterialRequirementEntry

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinySocketTypeScalarMaterialRequirementEntry -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        currencyItemHash

        -
        currencyItemHash: number
        - -
        -
        - -

        scalarValue

        -
        scalarValue: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinystat.html b/docs/interfaces/idestinystat.html deleted file mode 100644 index bef6a0a..0000000 --- a/docs/interfaces/idestinystat.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - IDestinyStat | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyStat

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents a stat on an item or Character (NOT a Historical Stat, but a - physical attribute stat like Attack, Defense etc...)

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyStat -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        maximumValue

        -
        maximumValue: number
        - -
        -
        -

        The highest possible value for the stat, if we were able to compute it. (I - wouldn't necessarily trust this value right now. I would like to improve its - calculation in later iterations of the API. Consider this a placeholder for - desired future functionality)

        -
        -
        -
        -
        - -

        statHash

        -
        statHash: number
        - -
        -
        -

        The hash identifier for the Stat. Use it to look up the DestinyStatDefinition - for static data about the stat.

        -
        -

        Mapped to IDestinyStatDefinition in the manifest.

        -
        -
        -
        - -

        value

        -
        value: number
        - -
        -
        -

        The current value of the Stat.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinystatdefinition.html b/docs/interfaces/idestinystatdefinition.html deleted file mode 100644 index 703ef4f..0000000 --- a/docs/interfaces/idestinystatdefinition.html +++ /dev/null @@ -1,364 +0,0 @@ - - - - - - IDestinyStatDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyStatDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This represents a stat that's applied to a character or an item (such as a - weapon, piece of armor, or a vehicle).

        -
        -

        An example of a stat might be Attack Power on a weapon.

        -

        Stats go through a complex set of transformations before they end up being shown - to the user as a number or a progress bar, and those transformations are - fundamentally intertwined with the concept of a "Stat Group" ( - DestinyStatGroupDefinition). Items have both Stats and a reference to a Stat - Group, and it is the Stat Group that takes the raw stat information and gives it - both rendering metadata (such as whether to show it as a number or a progress - bar) and the final transformation data (interpolation tables to turn the raw - investment stat into a display stat). Please see DestinyStatGroupDefinition for - more information on that transformational process.

        -

        Stats are segregated from Stat Groups because different items and types of items - can refer to the same stat, but have different "scales" for the stat while still - having the same underlying value. For example, both a Shotgun and an Auto Rifle - may have a "raw" impact stat of 50, but the Auto Rifle's Stat Group will scale - that 50 down so that, when it is displayed, it is a smaller value relative to - the shotgun. (this is a totally made up example, don't assume shotguns have - naturally higher impact than auto rifles because of this)

        -

        A final caveat is that some stats, even after this "final" transformation, go - through yet another set of transformations directly in the game as a result of - dynamic, stateful scripts that get run. BNet has no access to these scripts, nor - any way to know which scripts get executed. As a result, the stats for an item - that you see in-game - particularly for stats that are often impacted by Perks, - like Magazine Size - can change dramatically from what we return on Bungie.Net. - This is a known issue with no fix coming down the pipeline. Take these stats - with a grain of salt.

        -

        Stats actually go through four transformations, for those interested:

        -

        1) "Sandbox" stat, the "most raw" form. These are pretty much useless without - transformations applied, and thus are not currently returned in the API. If you - really want these, we can provide them. Maybe someone could do something cool - with it?

        -

        2) "Investment" stat (the stat's value after DestinyStatDefinition's - interpolation tables and aggregation logic is applied to the "Sandbox" stat - value)

        -

        3) "Display" stat (the stat's base UI-visible value after - DestinyStatGroupDefinition's interpolation tables are applied to the Investment - Stat value. For most stats, this is what is displayed.)

        -

        4) Underlying in-game stat (the stat's actual value according to the game, after - the game runs dynamic scripts based on the game and character's state. This is - the final transformation that BNet does not have access to. For most stats, this - is not actually displayed to the user, with the exception of Magazine Size which - is then piped back to the UI for display in-game, but not to BNet.)

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyStatDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        aggregationType

        - - -
        -
        -

        Stats can exist on a character or an item, and they may potentially be - aggregated in different ways. The DestinyStatAggregationType enum value - indicates the way that this stat is being aggregated.

        -
        -
        -
        -
        - -

        displayProperties

        - - -
        -
        - -

        hasComputedBlock

        -
        hasComputedBlock: boolean
        - -
        -
        -

        True if the stat is computed rather than being delivered as a raw value on items.

        -
        -

        For instance, the Light stat in Destiny 1 was a computed stat.

        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        statCategory

        -
        statCategory: DestinyStatCategory
        - -
        -
        -

        The category of the stat, according to the game.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinystatdisplaydefinition.html b/docs/interfaces/idestinystatdisplaydefinition.html deleted file mode 100644 index 85474bd..0000000 --- a/docs/interfaces/idestinystatdisplaydefinition.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - - IDestinyStatDisplayDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyStatDisplayDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Describes the way that an Item Stat (see DestinyStatDefinition) is transformed - using the DestinyStatGroupDefinition related to that item. See both of the - aforementioned definitions for more information about the stages of stat - transformation.

        -
        -

        This represents the transformation of a stat into a "Display" stat (the closest - value that BNet can get to the in-game display value of the stat)

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyStatDisplayDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        displayAsNumeric

        -
        displayAsNumeric: boolean
        - -
        -
        -

        If this is true, the stat should be displayed as a number. Otherwise, display it - as a progress bar. Or, you know, do whatever you want. There's no - displayAsNumeric police.

        -
        -
        -
        -
        - -

        displayInterpolation

        -
        displayInterpolation: IInterpolationPoint[]
        - -
        -
        -

        The interpolation table representing how the Investment Stat is transformed into - a Display Stat.

        -
        -

        See DestinyStatDefinition for a description of the stages of stat transformation.

        -
        -
        -
        - -

        maximumValue

        -
        maximumValue: number
        - -
        -
        -

        Regardless of the output of interpolation, this is the maximum possible value - that the stat can be. It should also be used as the upper bound for displaying - the stat as a progress bar (the minimum always being 0)

        -
        -
        -
        -
        - -

        statHash

        -
        statHash: number
        - -
        -
        -

        The hash identifier for the stat being transformed into a Display stat.

        -
        -

        Use it to look up the DestinyStatDefinition, or key into a - DestinyInventoryItemDefinition's stats property.

        -

        Mapped to IDestinyStatDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinystatgroupdefinition.html b/docs/interfaces/idestinystatgroupdefinition.html deleted file mode 100644 index 7557e93..0000000 --- a/docs/interfaces/idestinystatgroupdefinition.html +++ /dev/null @@ -1,356 +0,0 @@ - - - - - - IDestinyStatGroupDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyStatGroupDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        When an inventory item (DestinyInventoryItemDefinition) has Stats (such as - Attack Power), the item will refer to a Stat Group. This definition enumerates - the properties used to transform the item's "Investment" stats into "Display" - stats.

        -
        -

        See DestinyStatDefinition's documentation for information about the - transformation of Stats, and the meaning of an Investment vs. a Display stat.

        -

        If you don't want to do these calculations on your own, fear not: pulling live - data from the BNet endpoints will return display stat values pre-computed and - ready for you to use. I highly recommend this approach, saves a lot of time and - also accounts for certain stat modifiers that can't easily be accounted for - without live data (such as stat modifiers on Talent Grids and Socket Plugs)

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyStatGroupDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        maximumValue

        -
        maximumValue: number
        - -
        -
        -

        The maximum possible value that any stat in this group can be transformed into.

        -
        -

        This is used by stats that don't have scaledStats entries below, but that - still need to be displayed as a progress bar, in which case this is used as the - upper bound for said progress bar. (the lower bound is always 0)

        -
        -
        -
        - -

        overrides

        -
        overrides: object
        - -
        -
        -

        The game has the ability to override, based on the stat group, what the - localized text is that is displayed for Stats being shown on the item.

        -
        -

        Mercifully, no Stat Groups use this feature currently. If they start using them, - we'll all need to start using them (and those of you who are more prudent than I - am can go ahead and start pre-checking for this.)

        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        scaledStats

        - - -
        -
        -

        Any stat that requires scaling to be transformed from an "Investment" stat to a " - Display" stat will have an entry in this list. For more information on what - those types of stats mean and the transformation process, see - DestinyStatDefinition.

        -
        -

        In retrospect, I wouldn't mind if this was a dictionary keyed by the stat hash - instead. But I'm going to leave it be because [[After Apple Picking]].

        -
        -
        -
        - -

        uiPosition

        -
        uiPosition: number
        - -
        -
        -

        This apparently indicates the position of the stats in the UI? I've returned it - in case anyone can use it, but it's not of any use to us on BNet. Something's - being lost in translation with this value.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinystatoverridedefinition.html b/docs/interfaces/idestinystatoverridedefinition.html deleted file mode 100644 index 6555fef..0000000 --- a/docs/interfaces/idestinystatoverridedefinition.html +++ /dev/null @@ -1,239 +0,0 @@ - - - - - - IDestinyStatOverrideDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyStatOverrideDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Stat Groups (DestinyStatGroupDefinition) has the ability to override the - localized text associated with stats that are to be shown on the items with - which they are associated.

        -
        -

        This defines a specific overridden stat. You could theoretically check these - before rendering your stat UI, and for each stat that has an override show these - displayProperties instead of those on the DestinyStatDefinition.

        -

        Or you could be like us, and skip that for now because the game has yet to - actually use this feature. But know that it's here, waiting for a resilliant - young designer to take up the mantle and make us all look foolish by showing the - wrong name for stats.

        -

        Note that, if this gets used, the override will apply only to items using the - overriding Stat Group. Other items will still show the default stat's name/ - description.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyStatOverrideDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        -

        The display properties to show instead of the base DestinyStatDefinition display - properties.

        -
        -
        -
        -
        - -

        statHash

        -
        statHash: number
        - -
        -
        -

        The hash identifier of the stat whose display properties are being overridden.

        -
        -

        Mapped to IDestinyStatDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinytalentexclusivegroup.html b/docs/interfaces/idestinytalentexclusivegroup.html deleted file mode 100644 index 80a4418..0000000 --- a/docs/interfaces/idestinytalentexclusivegroup.html +++ /dev/null @@ -1,293 +0,0 @@ - - - - - - IDestinyTalentExclusiveGroup | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyTalentExclusiveGroup

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        As of Destiny 2, nodes can exist as part of "Exclusive Groups". These differ - from exclusive sets in that, within the group, many nodes can be activated. But - the act of activating any node in the group will cause "opposing" nodes (nodes - in groups that are not allowed to be activated at the same time as this group) - to deactivate.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyTalentExclusiveGroup -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        groupHash

        -
        groupHash: number
        - -
        -
        -

        The identifier for this exclusive group. Only guaranteed unique within the - talent grid, not globally.

        -
        -
        -
        -
        - -

        Optional loreHash

        -
        loreHash: number
        - -
        -
        -

        If this group has an associated piece of lore to show next to it, this will be - the identifier for that DestinyLoreDefinition.

        -
        -

        Mapped to IDestinyLoreDefinition in the manifest.

        -
        -
        -
        - -

        nodeHashes

        -
        nodeHashes: number[]
        - -
        -
        -

        A quick reference of the talent nodes that are part of this group, by their - Talent Node hashes. (See DestinyTalentNodeDefinition.nodeHash)

        -
        -
        -
        -
        - -

        opposingGroupHashes

        -
        opposingGroupHashes: number[]
        - -
        -
        -

        A quick reference of Groups whose nodes will be deactivated if any node in this - group is activated.

        -
        -
        -
        -
        - -

        opposingNodeHashes

        -
        opposingNodeHashes: number[]
        - -
        -
        -

        A quick reference of Nodes that will be deactivated if any node in this group is - activated, by their Talent Node hashes. (See DestinyTalentNodeDefinition. - nodeHash)

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinytalentgriddefinition.html b/docs/interfaces/idestinytalentgriddefinition.html deleted file mode 100644 index f18982f..0000000 --- a/docs/interfaces/idestinytalentgriddefinition.html +++ /dev/null @@ -1,477 +0,0 @@ - - - - - - IDestinyTalentGridDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyTalentGridDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The time has unfortunately come to talk about Talent Grids.

        -
        -

        Talent Grids are the most complex and unintuitive part of the Destiny Definition - data. Grab a cup of coffee before we begin, I can wait.

        -

        Talent Grids were the primary way that items could be customized in Destiny 1. - In Destiny 2, for now, talent grids have become exclusively used by Subclass/ - Build items: but the system is still in place for it to be used by items should - the direction change back toward talent grids.

        -

        Talent Grids have Nodes: the visual circles on the talent grid detail screen - that have icons and can be activated if you meet certain requirements and pay - costs. The actual visual data and effects, however, are driven by the "Steps" on - Talent Nodes. Any given node will have 1:M of these steps, and the specific step - that will be considered the "current" step (and thus the dictator of all - benefits, visual state, and activation requirements on the Node) will almost - always not be determined until an instance of the item is created. This is how, - in Destiny 1, items were able to have such a wide variety of what users saw as " - Perks": they were actually Talent Grids with nodes that had a wide variety of - Steps, randomly chosen at the time of item creation.

        -

        Now that Talent Grids are used exclusively by subclasses and builds, all of the - properties within still apply: but there are additional visual elements on the - Subclass/Build screens that are superimposed on top of the talent nodes. - Unfortunately, BNet doesn't have this data: if you want to build a subclass - screen, you will have to provide your own "decorative" assets, such as the - visual connectors between nodes and the fancy colored-fire-bathed character - standing behind the nodes.

        -

        DestinyInventoryItem.talentGrid.talentGridHash defines an item's linked Talent - Grid, which brings you to this definition that contains enough satic data about - talent grids to make your head spin. These must be combined with instanced - data - found when live data returns DestinyItemTalentGridComponent - in order to - derive meaning. The instanced data will reference nodes and steps within these - definitions, which you will then have to look up in the definition and combine - with the instanced data to give the user the visual representation of their item' - s talent grid.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyTalentGridDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        exclusiveSets

        - - -
        -
        -

        Talent Nodes can exist in "exclusive sets": these are sets of nodes in which - only a single node in the set can be activated at any given time. Activating a - node in this set will automatically deactivate the other nodes in the set ( - referred to as a "Swap").

        -
        -

        If a node in the exclusive set has already been activated, the game will not - charge you materials to activate another node in the set, even if you have never - activated it before, because you already paid the cost to activate one node in - the set.

        -

        Not to be confused with Exclusive Groups. (how the heck do we NOT get confused - by that? Jeez) See the groups property for information about that only- - tangentially-related concept.

        -
        -
        -
        - -

        gridLevelPerColumn

        -
        gridLevelPerColumn: number
        - -
        -
        -

        The meaning of this has been lost in the sands of time: it still exists as a - property, but appears to be unused in the modern UI of talent grids. It used to - imply that each visual "column" of talent nodes required identical progression - levels in order to be activated. Returning this value in case it is still useful - to someone? Perhaps it's just a bit of interesting history.

        -
        -
        -
        -
        - -

        groups

        -
        groups: object
        - -
        -
        -

        Talent Nodes can have "Exclusive Groups". These are not to be confused with - Exclusive Sets (see exclusiveSets property).

        -
        -

        Look at the definition of DestinyTalentExclusiveGroup for more information and - how they work. These groups are keyed by the "groupHash" from - DestinyTalentExclusiveGroup.

        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        independentNodeIndexes

        -
        independentNodeIndexes: number[]
        - -
        -
        -

        This is a quick reference to the indexes of nodes that are not part of exclusive - sets. Handy for knowing which talent nodes can only be activated directly, - rather than via swapping.

        -
        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        maxGridLevel

        -
        maxGridLevel: number
        - -
        -
        -

        The maximum possible level of the Talent Grid: at this level, any nodes are - allowed to be activated.

        -
        -
        -
        -
        - -

        nodeCategories

        -
        nodeCategories: IDestinyTalentNodeCategory[]
        - -
        -
        -

        BNet wants to show talent nodes grouped by similar purpose with localized titles. - This is the ordered list of those categories: if you want to show nodes by - category, you can iterate over this list, render the displayProperties for the - category as the title, and then iterate over the talent nodes referenced by the - category to show the related nodes.

        -
        -

        Note that this is different from Exclusive Groups or Sets, because these - categories also incorporate "Independent" nodes that belong to neither sets nor - groups. These are purely for visual grouping of nodes rather than functional - grouping.

        -
        -
        -
        - -

        nodes

        - - -
        -
        -

        The list of Talent Nodes on the Grid (recall that Nodes themselves are really - just locations in the UI to show whatever their current Step is. You will only - know the current step for a node by retrieving instanced data through platform - calls to the API that return DestinyItemTalentGridComponent).

        -
        -
        -
        -
        - -

        progressionHash

        -
        progressionHash: number
        - -
        -
        -

        The hash identifier of the Progression (DestinyProgressionDefinition) that - drives whether and when Talent Nodes can be activated on the Grid. Items will - have instances of this Progression, and will gain experience that will - eventually cause the grid to increase in level. As the grid's level increases, - it will cross the threshold where nodes can be activated. See - DestinyTalentGridStepDefinition's activation requirements for more information.

        -
        -

        Mapped to IDestinyProgressionDefinition in the manifest.

        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinytalentnode.html b/docs/interfaces/idestinytalentnode.html deleted file mode 100644 index 6db115c..0000000 --- a/docs/interfaces/idestinytalentnode.html +++ /dev/null @@ -1,414 +0,0 @@ - - - - - - IDestinyTalentNode | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyTalentNode

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        I see you've come to find out more about Talent Nodes. I'm so sorry. Talent - Nodes are the conceptual, visual nodes that appear on Talent Grids. Talent Grids, - in Destiny 1, were found on almost every instanced item: they had Nodes that - could be activated to change the properties of the item. In Destiny 2, Talent - Grids only exist for Builds/Subclasses, and while the basic concept is the same ( - Nodes can be activated once you've gained sufficient Experience on the Item, and - provide effects), there are some new concepts from Destiny 1. Examine - DestinyTalentGridDefinition and its subordinates for more information. This is - the "Live" information for the current status of a Talent Node on a specific - item. Talent Nodes have many Steps, but only one can be active at any one time: - and it is the Step that determines both the visual and the game state-changing - properties that the Node provides. Examine this and - DestinyTalentNodeStepDefinition carefully. IMPORTANT NOTE Talent Nodes are, - unfortunately, Content Version DEPENDENT. Though they refer to hashes for Nodes - and Steps, those hashes are not guaranteed to be immutable across content - versions. This is a source of great exasperation for me, but as a result anyone - using Talent Grid data must ensure that the content version of their static - content matches that of the server responses before showing or making decisions - based on talent grid data.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyTalentNode -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activationGridLevel

        -
        activationGridLevel: number
        - -
        -
        -

        The progression level required on the Talent Grid in order to be able to - activate this talent node. Talent Grids have their own Progression - similar to - Character Level, but in this case it is experience related to the item itself.

        -
        -
        -
        -
        - -

        hidden

        -
        hidden: boolean
        - -
        -
        -

        Whether or not the talent node is actually visible in the game's UI. Whether you - want to show it in your own UI is up to you! I'm not gonna tell you who to sock - it to.

        -
        -
        -
        -
        - -

        isActivated

        -
        isActivated: boolean
        - -
        -
        -

        If true, the node is activated: it's current step then provides its benefits.

        -
        -
        -
        -
        - -

        materialsToUpgrade

        -
        materialsToUpgrade: IDestinyMaterialRequirement[]
        - -
        -
        -

        If the node has material requirements to be activated, this is the list of those - requirements.

        -
        -
        -
        -
        - -

        nodeHash

        -
        nodeHash: number
        - -
        -
        -

        The hash of the Talent Node being referred to (in DestinyTalentGridDefinition. - nodes). Deceptively CONTENT VERSION DEPENDENT. We have no guarantee of the hash' - s immutability between content versions.

        -
        -
        -
        -
        - -

        nodeIndex

        -
        nodeIndex: number
        - -
        -
        -

        The index of the Talent Node being referred to (an index into - DestinyTalentGridDefinition.nodes[]). CONTENT VERSION DEPENDENT.

        -
        -
        -
        -
        - -

        nodeStatsBlock

        - - -
        -
        -

        This property has some history. A talent grid can provide stats on both the item - it's related to and the character equipping the item. This returns data about - those stat bonuses.

        -
        -
        -
        -
        - -

        progressPercent

        -
        progressPercent: number
        - -
        -
        -

        If you want to show a progress bar or circle for how close this talent node is - to being activate-able, this is the percentage to show. It follows the node's - underlying rules about when the progress bar should first show up, and when it - should be filled.

        -
        -
        -
        -
        - -

        state

        - - -
        -
        -

        An DestinyTalentNodeState enum value indicating the node's state: whether it can - be activated or swapped, and why not if neither can be performed.

        -
        -
        -
        -
        - -

        stepIndex

        -
        stepIndex: number
        - -
        -
        -

        The currently relevant Step for the node. It is this step that has rendering - data for the node and the benefits that are provided if the node is activated. ( - the actual rules for benefits provided are extremely complicated in theory, but - with how Talent Grids are being used in Destiny 2 you don't have to worry about - a lot of those old Destiny 1 rules.) This is an index into: - DestinyTalentGridDefinition.nodes[nodeIndex].steps[stepIndex]

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinytalentnodecategory.html b/docs/interfaces/idestinytalentnodecategory.html deleted file mode 100644 index b5e10b5..0000000 --- a/docs/interfaces/idestinytalentnodecategory.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - - IDestinyTalentNodeCategory | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyTalentNodeCategory

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        An artificial construct provided by Bungie.Net, where we attempt to group talent - nodes by functionality.

        -
        -

        This is a single set of references to Talent Nodes that share a common trait or - purpose.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyTalentNodeCategory -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        -

        Will contain at least the "name", which will be the title of the category. We - will likely not have description and an icon yet, but I'm going to keep my - options open.

        -
        -
        -
        -
        - -

        identifier

        -
        identifier: string
        - -
        -
        -

        Mostly just for debug purposes, but if you find it useful you can have it. This - is BNet's manually created identifier for this category.

        -
        -
        -
        -
        - -

        isLoreDriven

        -
        isLoreDriven: boolean
        - -
        -
        -

        If true, we found the localized content in a related DestinyLoreDefinition - instead of local BNet localization files. This is mostly for ease of my own - future investigations.

        -
        -
        -
        -
        - -

        nodeHashes

        -
        nodeHashes: number[]
        - -
        -
        -

        The set of all hash identifiers for Talent Nodes (DestinyTalentNodeDefinition) - in this Talent Grid that are part of this Category.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinytalentnodedefinition.html b/docs/interfaces/idestinytalentnodedefinition.html deleted file mode 100644 index fb0e755..0000000 --- a/docs/interfaces/idestinytalentnodedefinition.html +++ /dev/null @@ -1,609 +0,0 @@ - - - - - - IDestinyTalentNodeDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyTalentNodeDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Talent Grids on items have Nodes. These nodes have positions in the talent grid' - s UI, and contain "Steps" (DestinyTalentNodeStepDefinition), one of whom will be - the "Current" step.

        -
        -

        The Current Step determines the visual properties of the node, as well as what - the node grants when it is activated.

        -

        See DestinyTalentGridDefinition for a more complete overview of how Talent Grids - work, and how they are used in Destiny 2 (and how they were used in Destiny 1).

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyTalentNodeDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        autoUnlocks

        -
        autoUnlocks: boolean
        - -
        -
        -

        If true, this node will automatically unlock when the Talent Grid's level - reaches the required level of the current step of this node.

        -
        -
        -
        -
        - -

        binaryPairNodeIndex

        -
        binaryPairNodeIndex: number
        - -
        -
        -

        At one point, Talent Nodes supported the idea of "Binary Pairs": nodes that - overlapped each other visually, and where activating one deactivated the other. - They ended up not being used, mostly because Exclusive Sets are almost a - superset of this concept, but the potential for it to be used still exists in - theory.

        -
        -

        If this is ever used, this will be the index into the - DestinyTalentGridDefinition.nodes property for the node that is the binary pair - match to this node. Activating one deactivates the other.

        -
        -
        -
        - -

        column

        -
        column: number
        - -
        -
        -

        The visual "column" where the node should be shown in the UI. If negative, the - node is hidden.

        -
        -
        -
        -
        - -

        exclusiveWithNodeHashes

        -
        exclusiveWithNodeHashes: number[]
        - -
        -
        -

        The nodeHash values for nodes that are in an Exclusive Set with this node.

        -
        -

        See DestinyTalentGridDefinition.exclusiveSets for more info about exclusive sets.

        -

        Again, note that these are nodeHashes and not nodeIndexes.

        -
        -
        -
        - -

        Optional groupHash

        -
        groupHash: number
        - -
        -
        -

        As of Destiny 2, nodes can exist as part of "Exclusive Groups". These differ - from exclusive sets in that, within the group, many nodes can be activated. But - the act of activating any node in the group will cause "opposing" nodes (nodes - in groups that are not allowed to be activated at the same time as this group) - to deactivate.

        -
        -

        See DestinyTalentExclusiveGroup for more information on the details. This is an - identifier for this node's group, if it is part of one.

        -
        -
        -
        - -

        ignoreForCompletion

        -
        ignoreForCompletion: boolean
        - -
        -
        -

        Comes from the talent grid node style: if true, then this node should be ignored - for determining whether the grid is complete.

        -
        -
        -
        -
        - -

        isRandom

        -
        isRandom: boolean
        - -
        -
        -

        If this is true, the node's step is determined randomly rather than the first - step being chosen.

        -
        -
        -
        -
        - -

        isRandomRepurchasable

        -
        isRandomRepurchasable: boolean
        - -
        -
        -

        If this is true, the node can be "re-rolled" to acquire a different random - current step. This is not used, but still exists for a theoretical future of - talent grids.

        -
        -
        -
        -
        - -

        lastStepRepeats

        -
        lastStepRepeats: boolean
        - -
        -
        -

        At one point, Nodes were going to be able to be activated multiple times, - changing the current step and potentially piling on multiple effects from the - previously activated steps. This property would indicate if the last step could - be activated multiple times.

        -
        -

        This is not currently used, but it isn't out of the question that this could end - up being used again in a theoretical future.

        -
        -
        -
        - -

        layoutIdentifier

        -
        layoutIdentifier: string
        - -
        -
        -

        A string identifier for a custom visual layout to apply to this talent node. - Unfortunately, we do not have any data for rendering these custom layouts. It - will be up to you to interpret these strings and change your UI if you want to - have custom UI matching these layouts.

        -
        -
        -
        -
        - -

        Optional loreHash

        -
        loreHash: number
        - -
        -
        -

        Talent nodes can be associated with a piece of Lore, generally rendered in a - tooltip. This is the hash identifier of the lore element to show, if there is - one to be show.

        -
        -

        Mapped to IDestinyLoreDefinition in the manifest.

        -
        -
        -
        - -

        nodeHash

        -
        nodeHash: number
        - -
        -
        -

        The hash identifier for the node, which unfortunately is also content version - dependent but can be (and ideally, should be) used instead of the nodeIndex to - uniquely identify the node.

        -
        -

        The two exist side-by-side for backcompat reasons due to the Great Talent Node - Restructuring of Destiny 1, and I ran out of time to remove one of them and - standardize on the other. Sorry!

        -
        -
        -
        - -

        nodeIndex

        -
        nodeIndex: number
        - -
        -
        -

        The index into the DestinyTalentGridDefinition's "nodes" property where this - node is located. Used to uniquely identify the node within the Talent Grid. Note - that this is content version dependent: make sure you have the latest version of - content before trying to use these properties.

        -
        -
        -
        -
        - -

        nodeStyleIdentifier

        -
        nodeStyleIdentifier: string
        - -
        -
        -

        Comes from the talent grid node style: this identifier should be used to - determine how to render the node in the UI.

        -
        -
        -
        -
        - -

        prerequisiteNodeIndexes

        -
        prerequisiteNodeIndexes: number[]
        - -
        -
        -

        Indexes into the DestinyTalentGridDefinition.nodes property for any nodes that - must be activated before this one is allowed to be activated.

        -
        -

        I would have liked to change this to hashes for Destiny 2, but we have run out - of time.

        -
        -
        -
        - -

        randomActivationRequirement

        -
        randomActivationRequirement: IDestinyNodeActivationRequirement
        - -
        -
        -

        At one point, you were going to be able to repurchase talent nodes that had - random steps, to "re-roll" the current step of the node (and thus change the - properties of your item). This was to be the activation requirement for - performing that re-roll.

        -
        -

        The system still exists to do this, as far as I know, so it may yet come back - around!

        -
        -
        -
        - -

        randomStartProgressionBarAtProgression

        -
        randomStartProgressionBarAtProgression: number
        - -
        -
        -

        If the node's step is randomly selected, this is the amount of the Talent Grid's - progression experience at which the progression bar for the node should be shown.

        -
        -
        -
        -
        - -

        row

        -
        row: number
        - -
        -
        -

        The visual "row" where the node should be shown in the UI. If negative, then the - node is hidden.

        -
        -
        -
        -
        - -

        steps

        - - -
        -
        -

        At this point, "steps" have been obfuscated into conceptual entities, - aggregating the underlying notions of "properties" and "true steps".

        -
        -

        If you need to know a step as it truly exists - such as when recreating Node - logic when processing Vendor data - you'll have to use the "realSteps" property - below.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinytalentnodeexclusivesetdefinition.html b/docs/interfaces/idestinytalentnodeexclusivesetdefinition.html deleted file mode 100644 index 74969bb..0000000 --- a/docs/interfaces/idestinytalentnodeexclusivesetdefinition.html +++ /dev/null @@ -1,209 +0,0 @@ - - - - - - IDestinyTalentNodeExclusiveSetDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyTalentNodeExclusiveSetDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The list of indexes into the Talent Grid's "nodes" property for nodes in this - exclusive set. (See DestinyTalentNodeDefinition.nodeIndex)

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyTalentNodeExclusiveSetDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        nodeIndexes

        -
        nodeIndexes: number[]
        - -
        -
        -

        The list of node indexes for the exclusive set. Historically, these were indexes. - I would have liked to replace this with nodeHashes for consistency, but it's - way too late for that. (9:09 PM, he's right!)

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinytalentnodestatblock.html b/docs/interfaces/idestinytalentnodestatblock.html deleted file mode 100644 index 58b4018..0000000 --- a/docs/interfaces/idestinytalentnodestatblock.html +++ /dev/null @@ -1,234 +0,0 @@ - - - - - - IDestinyTalentNodeStatBlock | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyTalentNodeStatBlock

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This property has some history. A talent grid can provide stats on both the item - it's related to and the character equipping the item. This returns data about - those stat bonuses.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyTalentNodeStatBlock -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        currentStepStats

        -
        currentStepStats: IDestinyStat[]
        - -
        -
        -

        The stat benefits conferred when this talent node is activated for the current - Step that is active on the node.

        -
        -
        -
        -
        - -

        nextStepStats

        -
        nextStepStats: IDestinyStat[]
        - -
        -
        -

        This is a holdover from the old days of Destiny 1, when a node could be - activated multiple times, conferring multiple steps worth of benefits: you would - use this property to show what activating the "next" step on the node would - provide vs. what the current step is providing. While Nodes are currently not - being used this way, the underlying system for this functionality still exists. - I hesitate to remove this property while the ability for designers to make such - a talent grid still exists. Whether you want to show it is up to you.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinytalentnodestepgroups.html b/docs/interfaces/idestinytalentnodestepgroups.html deleted file mode 100644 index 46eb23c..0000000 --- a/docs/interfaces/idestinytalentnodestepgroups.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - - - IDestinyTalentNodeStepGroups | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyTalentNodeStepGroups

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        These properties are an attempt to categorize talent node steps by certain - common properties. See the related enumerations for the type of properties being - categorized.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyTalentNodeStepGroups -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        damageTypes

        - - -
        -
        - -

        guardianAttributes

        - - -
        -
        - -

        impactEffects

        - - -
        -
        - -

        lightAbilities

        - - -
        -
        - -

        weaponPerformance

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyunlockdefinition.html b/docs/interfaces/idestinyunlockdefinition.html deleted file mode 100644 index c3c4317..0000000 --- a/docs/interfaces/idestinyunlockdefinition.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - - IDestinyUnlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyUnlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Unlock Flags are small bits (literally, a bit, as in a boolean value) that the - game server uses for an extremely wide range of state checks, progress storage, - and other interesting tidbits of information.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyUnlockDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayProperties

        - - -
        -
        -

        Sometimes, but not frequently, these unlock flags also have human readable - information: usually when they are being directly tested for some requirement, - in which case the string is a localized description of why the requirement check - failed.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyunlockexpressiondefinition.html b/docs/interfaces/idestinyunlockexpressiondefinition.html deleted file mode 100644 index 1cec519..0000000 --- a/docs/interfaces/idestinyunlockexpressiondefinition.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - IDestinyUnlockExpressionDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyUnlockExpressionDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Where the sausage gets made. Unlock Expressions are the foundation of the game's - gating mechanics and investment-related restrictions. They can test Unlock Flags - and Unlock Values for certain states, using a sufficient amount of logical - operators such that unlock expressions are effectively Turing complete.

        -
        -

        Use UnlockExpressionParser to evaluate expressions using an IUnlockContext - parsed from Babel.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyUnlockExpressionDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        scope

        - - -
        -
        -

        A shortcut for determining the most restrictive gating that this expression - performs. See the DestinyGatingScope enum's documentation for more details.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyunlockstatus.html b/docs/interfaces/idestinyunlockstatus.html deleted file mode 100644 index 8da83c5..0000000 --- a/docs/interfaces/idestinyunlockstatus.html +++ /dev/null @@ -1,233 +0,0 @@ - - - - - - IDestinyUnlockStatus | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyUnlockStatus

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Indicates the status of an "Unlock Flag" on a Character or Profile.

        -
        -

        These are individual bits of state that can be either set or not set, and - sometimes provide interesting human-readable information in their related - DestinyUnlockDefinition.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyUnlockStatus -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        isSet

        -
        isSet: boolean
        - -
        -
        -

        Whether the unlock flag is set.

        -
        -
        -
        -
        - -

        unlockHash

        -
        unlockHash: number
        - -
        -
        -

        The hash identifier for the Unlock Flag. Use to lookup DestinyUnlockDefinition - for static data. Not all unlocks have human readable data - in fact, most don't. - But when they do, it can be very useful to show. Even if they don't have human - readable data, you might be able to infer the meaning of an unlock flag with a - bit of experimentation...

        -
        -

        Mapped to IDestinyUnlockDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyunlockvaluedefinition.html b/docs/interfaces/idestinyunlockvaluedefinition.html deleted file mode 100644 index b331fe3..0000000 --- a/docs/interfaces/idestinyunlockvaluedefinition.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - - - IDestinyUnlockValueDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyUnlockValueDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        An Unlock Value is an internal integer value, stored on the server and used in a - variety of ways, most frequently for the gating/requirement checks that the game - performs across all of its main features. They can also be used as the storage - data for mapped Progressions, Objectives, and other features that require - storage of variable numeric values.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyUnlockValueDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendoraccepteditemdefinition.html b/docs/interfaces/idestinyvendoraccepteditemdefinition.html deleted file mode 100644 index fd7b671..0000000 --- a/docs/interfaces/idestinyvendoraccepteditemdefinition.html +++ /dev/null @@ -1,239 +0,0 @@ - - - - - - IDestinyVendorAcceptedItemDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorAcceptedItemDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If you ever wondered how the Vault works, here it is.

        -
        -

        The Vault is merely a set of inventory buckets that exist on your Profile/ - Account level. When you transfer items in the Vault, the game is using the Vault - Vendor's DestinyVendorAcceptedItemDefinitions to see where the appropriate - destination bucket is for the source bucket from whence your item is moving. If - it finds such an entry, it transfers the item to the other bucket.

        -

        The mechanics for Postmaster works similarly, which is also a vendor. All driven - by Accepted Items.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorAcceptedItemDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        acceptedInventoryBucketHash

        -
        acceptedInventoryBucketHash: number
        - -
        -
        -

        The "source" bucket for a transfer. When a user wants to transfer an item, the - appropriate DestinyVendorDefinition's acceptedItems property is evaluated, - looking for an entry where acceptedInventoryBucketHash matches the bucket that - the item being transferred is currently located. If it exists, the item will be - transferred into whatever bucket is defined by destinationInventoryBucketHash.

        -
        -

        Mapped to IDestinyInventoryBucketDefinition in the manifest.

        -
        -
        -
        - -

        destinationInventoryBucketHash

        -
        destinationInventoryBucketHash: number
        - -
        -
        -

        This is the bucket where the item being transferred will be put, given that it - was being transferred from the bucket defined in acceptedInventoryBucketHash.

        -
        -

        Mapped to IDestinyInventoryBucketDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendoractiondefinition.html b/docs/interfaces/idestinyvendoractiondefinition.html deleted file mode 100644 index 0ee9474..0000000 --- a/docs/interfaces/idestinyvendoractiondefinition.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - - IDestinyVendorActionDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorActionDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If a vendor can ever end up performing actions, these are the properties that - will be related to those actions. I'm not going to bother documenting this yet, - as it is unused and unclear if it will ever be used... but in case it is ever - populated and someone finds it useful, it is defined here.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorActionDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        actionHash

        -
        actionHash: number
        - -
        -
        - -

        actionId

        -
        actionId: string
        - -
        -
        - -

        autoPerformAction

        -
        autoPerformAction: boolean
        - -
        -
        - -

        description

        -
        description: string
        - -
        -
        - -

        executeSeconds

        -
        executeSeconds: number
        - -
        -
        - -

        icon

        -
        icon: string
        - -
        -
        - -

        isPositive

        -
        isPositive: boolean
        - -
        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        verb

        -
        verb: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorcategoriescomponent.html b/docs/interfaces/idestinyvendorcategoriescomponent.html deleted file mode 100644 index 104338e..0000000 --- a/docs/interfaces/idestinyvendorcategoriescomponent.html +++ /dev/null @@ -1,213 +0,0 @@ - - - - - - IDestinyVendorCategoriesComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorCategoriesComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A vendor can have many categories of items that they sell. This component will - return the category information for available items, as well as the index into - those items in the user's sale item list.

        -
        -

        Note that, since both the category and items are indexes, this data is Content - Version dependent. Be sure to check that your content is up to date before using - this data. This is an unfortunate, but permanent, limitation of Vendor data.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorCategoriesComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        categories

        - - -
        -
        -

        The list of categories for items that the vendor sells, in rendering order.

        -
        -

        These categories each point to a "display category" in the displayCategories - property of the DestinyVendorDefinition, as opposed to the other categories.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorcategory.html b/docs/interfaces/idestinyvendorcategory.html deleted file mode 100644 index 8cb65cf..0000000 --- a/docs/interfaces/idestinyvendorcategory.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - - IDestinyVendorCategory | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorCategory

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Information about the category and items currently sold in that category.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorCategory -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayCategoryIndex

        -
        displayCategoryIndex: number
        - -
        -
        -

        An index into the DestinyVendorDefinition.displayCategories property, so you can - grab the display data for this category.

        -
        -
        -
        -
        - -

        itemIndexes

        -
        itemIndexes: number[]
        - -
        -
        -

        An ordered list of indexes into items being sold in this category ( - DestinyVendorDefinition.itemList) which will contain more information about the - items being sold themselves. Can also be used to index into - DestinyVendorSaleItemComponent data, if you asked for that data to be returned.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorcategoryentrydefinition.html b/docs/interfaces/idestinyvendorcategoryentrydefinition.html deleted file mode 100644 index 0ac739c..0000000 --- a/docs/interfaces/idestinyvendorcategoryentrydefinition.html +++ /dev/null @@ -1,511 +0,0 @@ - - - - - - IDestinyVendorCategoryEntryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorCategoryEntryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This is the definition for a single Vendor Category, into which Sale Items are - grouped.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorCategoryEntryDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        buyStringOverride

        -
        buyStringOverride: string
        - -
        -
        -

        The localized string for making purchases from this category, if it is different - from the vendor's string for purchasing.

        -
        -
        -
        -
        - -

        categoryHash

        -
        categoryHash: number
        - -
        -
        -

        The hashed identifier for the category.

        -
        -
        -
        -
        - -

        categoryId

        -
        categoryId: string
        - -
        -
        -

        The string identifier of the category.

        -
        -
        -
        -
        - -

        categoryIndex

        -
        categoryIndex: number
        - -
        -
        -

        The index of the category in the original category definitions for the vendor.

        -
        -
        -
        -
        - -

        disabledDescription

        -
        disabledDescription: string
        - -
        -
        -

        If the category is disabled, this is the localized description to show.

        -
        -
        -
        -
        - -

        displayTitle

        -
        displayTitle: string
        - -
        -
        -

        The localized title of the category.

        -
        -
        -
        -
        - -

        hideFromRegularPurchase

        -
        hideFromRegularPurchase: boolean
        - -
        -
        -

        True if this category doesn't allow purchases.

        -
        -
        -
        -
        - -

        hideIfNoCurrency

        -
        hideIfNoCurrency: boolean
        - -
        -
        -

        If you don't have the currency required to buy items from this category, should - the items be hidden?

        -
        -
        -
        -
        - -

        isDisplayOnly

        -
        isDisplayOnly: boolean
        - -
        -
        -

        If true, this category only displays items: you can't purchase anything in them.

        -
        -
        -
        -
        - -

        isPreview

        -
        isPreview: boolean
        - -
        -
        -

        Sometimes a category isn't actually used to sell items, but rather to preview - them. This implies different UI (and manual placement of the category in the UI) - in the game, and special treatment.

        -
        -
        -
        -
        - -

        overlay

        - - -
        -
        -

        If this category has an overlay prompt that should appear, this contains the - details of that prompt.

        -
        -
        -
        -
        - -

        quantityAvailable

        -
        quantityAvailable: number
        - -
        -
        -

        The amount of items that will be available when this category is shown.

        -
        -
        -
        -
        - -

        resetIntervalMinutesOverride

        -
        resetIntervalMinutesOverride: number
        - -
        -
        - -

        resetOffsetMinutesOverride

        -
        resetOffsetMinutesOverride: number
        - -
        -
        - -

        showUnavailableItems

        -
        showUnavailableItems: boolean
        - -
        -
        -

        If items aren't up for sale in this category, should we still show them (greyed - out)?

        -
        -
        -
        -
        - -

        sortValue

        -
        sortValue: number
        - -
        -
        -

        Used in sorting items in vendors... but there's a lot more to it. Just go with - the order provided in the itemIndexes property on the - DestinyVendorCategoryComponent instead, it should be more reliable than trying - to recalculate it yourself.

        -
        -
        -
        -
        - -

        vendorItemIndexes

        -
        vendorItemIndexes: number[]
        - -
        -
        -

        A shortcut for the vendor item indexes sold under this category. Saves us from - some expensive reorganization at runtime.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorcategoryoverlaydefinition.html b/docs/interfaces/idestinyvendorcategoryoverlaydefinition.html deleted file mode 100644 index 67b26cf..0000000 --- a/docs/interfaces/idestinyvendorcategoryoverlaydefinition.html +++ /dev/null @@ -1,263 +0,0 @@ - - - - - - IDestinyVendorCategoryOverlayDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorCategoryOverlayDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The details of an overlay prompt to show to a user. They are all fairly self- - explanatory localized strings that can be shown.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorCategoryOverlayDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        choiceDescription

        -
        choiceDescription: string
        - -
        -
        - -

        Optional currencyItemHash

        -
        currencyItemHash: number
        - -
        -
        -

        If this overlay has a currency item that it features, this is said featured item.

        -
        -
        -
        -
        - -

        description

        -
        description: string
        - -
        -
        - -

        icon

        -
        icon: string
        - -
        -
        - -

        title

        -
        title: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorcomponent.html b/docs/interfaces/idestinyvendorcomponent.html deleted file mode 100644 index 7875c9b..0000000 --- a/docs/interfaces/idestinyvendorcomponent.html +++ /dev/null @@ -1,339 +0,0 @@ - - - - - - IDestinyVendorComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This component contains essential/summary information about the vendor.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorComponent -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        canPurchase

        -
        canPurchase: boolean
        - -
        -
        -

        If True, you can purchase from the Vendor.

        -
        -

        Theoretically, Vendors can be restricted from selling items. In practice, none - do that (yet?).

        -
        -
        -
        - -

        enabled

        -
        enabled: boolean
        - -
        -
        -

        If True, the Vendor is currently accessible.

        -
        -

        If False, they may not actually be visible in the world at the moment.

        -
        -
        -
        - -

        nextRefreshDate

        -
        nextRefreshDate: string
        - -
        -
        -

        The date when this vendor's inventory will next rotate/refresh.

        -
        -

        Note that this is distinct from the date ranges that the vendor is visible/ - available in-game: this field indicates the specific time when the vendor's - available items refresh and rotate, regardless of whether the vendor is actually - available at that time. Unfortunately, these two values may be (and are, for the - case of important vendors like Xur) different.

        -

        Issue https://github.com/Bungie-net/api/issues/353 is tracking a fix to start - providing visibility date ranges where possible in addition to this refresh date, - so that all important dates for vendors are available for use.

        -
        -
        -
        - -

        progression

        -
        progression: IDestinyProgression
        - -
        -
        -

        If the Vendor has a related Reputation, this is the Progression data that - represents the character's Reputation level with this Vendor.

        -
        -
        -
        -
        - -

        Optional seasonalRank

        -
        seasonalRank: number
        - -
        -
        -

        If this vendor has a seasonal rank, this will be the calculated value of that - rank. How nice is that? I mean, that's pretty sweeet. It's a whole 32 bit - integer.

        -
        -
        -
        -
        - -

        vendorHash

        -
        vendorHash: number
        - -
        -
        -

        The unique identifier for the vendor. Use it to look up their - DestinyVendorDefinition.

        -
        -

        Mapped to IDestinyVendorDefinition in the manifest.

        -
        -
        -
        - -

        vendorLocationIndex

        -
        vendorLocationIndex: number
        - -
        -
        -

        An index into the vendor definition's "locations" property array, indicating - which location they are at currently. If -1, then the vendor has no known - location (and you may choose not to show them in your UI as a result. I mean, it' - s your bag honey)

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendordefinition.html b/docs/interfaces/idestinyvendordefinition.html deleted file mode 100644 index ca45071..0000000 --- a/docs/interfaces/idestinyvendordefinition.html +++ /dev/null @@ -1,930 +0,0 @@ - - - - - - IDestinyVendorDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        These are the definitions for Vendors.

        -
        -

        In Destiny, a Vendor can be a lot of things - some things that you wouldn't - expect, and some things that you don't even see directly in the game. Vendors - are the Dolly Levi of the Destiny universe.

        -
          -
        • Traditional Vendors as you see in game: people who you come up to and who give - you quests, rewards, or who you can buy things from.

          -
        • -
        • Kiosks/Collections, which are really just Vendors that don't charge currency ( - or charge some pittance of a currency) and whose gating for purchases revolves - more around your character's state.

          -
        • -
        • Previews for rewards or the contents of sacks. These are implemented as - Vendors, where you can't actually purchase from them but the items that they - have for sale and the categories of sale items reflect the rewards or contents - of the sack. This is so that the game could reuse the existing Vendor display UI - for rewards and save a bunch of wheel reinvention.

          -
        • -
        • Item Transfer capabilities, like the Vault and Postmaster. Vendors can have " - acceptedItem" buckets that determine the source and destination buckets for - transfers. When you interact with such a vendor, these buckets are what gets - shown in the UI instead of any items that the Vendor would have for sale. Yep, - the Vault is a vendor.

          -
        • -
        -

        It is pretty much guaranteed that they'll be used for even more features in the - future. They have come to be seen more as generic categorized containers for - items than "vendors" in a traditional sense, for better or worse.

        -

        Where possible and time allows, we'll attempt to split those out into their own - more digestible derived "Definitions": but often time does not allow that, as - you can see from the above ways that vendors are used which we never split off - from Vendor Definitions externally.

        -

        Since Vendors are so many things to so many parts of the game, the definition is - understandably complex. You will want to combine this data with live Vendor - information from the API when it is available.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        acceptedItems

        - - -
        -
        -

        If the Vendor is actually a vehicle for the transferring of items (like the - Vault and Postmaster vendors), this defines the list of source->destination - buckets for transferring.

        -
        -
        -
        -
        - -

        actions

        - - -
        -
        -

        Describes "actions" that can be performed on a vendor. Currently, none of these - exist. But theoretically a Vendor could let you interact with it by performing - actions. We'll see what these end up looking like if they ever get used.

        -
        -
        -
        -
        - -

        buyString

        -
        buyString: string
        - -
        -
        -

        If the vendor has a custom localized string describing the "buy" action, that is - returned here.

        -
        -
        -
        -
        - -

        categories

        - - -
        -
        -

        These are the headers for sections of items that the vendor is selling. When you - see items organized by category in the header, it is these categories that it is - showing.

        -
        -

        Well, technically not exactly these. On BNet, it doesn't make sense to have - categories be "paged" as we do in Destiny, so we run some heuristics to attempt - to aggregate pages of categories together.

        -

        These are the categories post-concatenation, if the vendor had concatenation - applied. If you want the pre-aggregated category data, use originalCategories.

        -
        -
        -
        - -

        consolidateCategories

        -
        consolidateCategories: boolean
        - -
        -
        -

        If TRUE, consolidate categories that only differ by trivial properties (such as - having minor differences in name)

        -
        -
        -
        -
        - -

        displayCategories

        - - -
        -
        -

        Display Categories are different from "categories" in that these are - specifically for visual grouping and display of categories in Vendor UI.

        -
        -

        The "categories" structure is for validation of the contained items, and can be - categorized entirely separately from "Display Categories", there need be and - often will be no meaningful relationship between the two.

        -
        -
        -
        - -

        displayItemHash

        -
        displayItemHash: number
        - -
        -
        -

        If the vendor has an item that should be displayed as the "featured" item, this - is the hash identifier for that DestinyVendorItemDefinition.

        -
        -

        Apparently this is usually a related currency, like a reputation token. But it - need not be restricted to that.

        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        displayProperties

        - - -
        -
        - -

        enabled

        -
        enabled: boolean
        - -
        -
        -

        If a vendor is not enabled, we won't even save the vendor's definition, and we - won't return any items or info about them. It's as if they don't exist.

        -
        -
        -
        -
        - -

        factionHash

        -
        factionHash: number
        - -
        -
        -

        If the Vendor has a faction, this hash will be valid and point to a - DestinyFactionDefinition.

        -
        -

        The game UI and BNet often mine the faction definition for additional elements - and details to place on the screen, such as the faction's Progression status ( - aka "Reputation").

        -

        Mapped to IDestinyFactionDefinition in the manifest.

        -
        -
        -
        - -

        failureStrings

        -
        failureStrings: string[]
        - -
        -
        -

        If an item can't be purchased from the vendor, there may be many "custom"/game - state specific reasons why not.

        -
        -

        This is a list of localized strings with messages for those custom failures. The - live BNet data will return a failureIndexes property for items that can't be - purchased: using those values to index into this array, you can show the user - the appropriate failure message for the item that can't be bought.

        -
        -
        -
        - -

        groups

        - - -
        -
        -

        A vendor can be a part of 0 or 1 "groups" at a time: a group being a collection - of Vendors related by either location or function/purpose. It's used for our our - Companion Vendor UI. Only one of these can be active for a Vendor at a time.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        ignoreSaleItemHashes

        -
        ignoreSaleItemHashes: number[]
        - -
        -
        -

        Some items don't make sense to return in the API, for example because they - represent an action to be performed rather than an item being sold. I'd rather - we not do this, but at least in the short term this is a workable workaround.

        -
        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        inhibitBuying

        -
        inhibitBuying: boolean
        - -
        -
        -

        If this is true, you aren't allowed to buy whatever the vendor is selling.

        -
        -
        -
        -
        - -

        inhibitSelling

        -
        inhibitSelling: boolean
        - -
        -
        -

        If this is true, you're not allowed to sell whatever the vendor is buying.

        -
        -
        -
        -
        - -

        interactions

        - - -
        -
        -

        In addition to selling items, vendors can have "interactions": UI where you " - talk" with the vendor and they offer you a reward, some item, or merely - acknowledge via dialog that you did something cool.

        -
        -
        -
        -
        - -

        inventoryFlyouts

        - - -
        -
        -

        If the vendor shows you items from your own inventory - such as the Vault vendor - does - this data describes the UI around showing those inventory buckets and - which ones get shown.

        -
        -
        -
        -
        - -

        itemList

        - - -
        -
        -

        If the vendor sells items (or merely has a list of items to show like the "Sack" - vendors do), this is the list of those items that the vendor can sell. From this - list, only a subset will be available from the vendor at any given time, - selected randomly and reset on the vendor's refresh interval.

        -
        -

        Note that a vendor can sell the same item multiple ways: for instance, nothing - stops a vendor from selling you some specific weapon but using two different - currencies, or the same weapon at multiple "item levels".

        -
        -
        -
        - -

        locations

        - - -
        -
        -

        A vendor can be at different places in the world depending on the game/character/ - account state. This is the list of possible locations for the vendor, along with - conditions we use to determine which one is currently active.

        -
        -
        -
        -
        - -

        originalCategories

        - - -
        -
        -

        See the categories property for a description of categories and why - originalCategories exists.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        - -

        resetIntervalMinutes

        -
        resetIntervalMinutes: number
        - -
        -
        -

        A number used for calculating the frequency of a vendor's inventory resetting/ - refreshing.

        -
        -

        Don't worry about calculating this - we do it on the server side and send you - the next refresh date with the live data.

        -
        -
        -
        - -

        resetOffsetMinutes

        -
        resetOffsetMinutes: number
        - -
        -
        -

        Again, used for reset/refreshing of inventory. Don't worry too much about it. - Unless you want to.

        -
        -
        -
        -
        - -

        returnWithVendorRequest

        -
        returnWithVendorRequest: boolean
        - -
        -
        -

        As many of you know, Vendor data has historically been pretty brutal on the BNet - servers. In an effort to reduce this workload, only Vendors with this flag set - will be returned on Vendor requests. This allows us to filter out Vendors that - don't dynamic data that's particularly useful: things like "Preview/Sack" - vendors, for example, that you can usually suss out the details for using just - the definitions themselves.

        -
        -
        -
        -
        - -

        sellString

        -
        sellString: string
        - -
        -
        -

        Ditto for selling. Not that you can sell items to a vendor anymore. Will it come - back? Who knows. The string's still there.

        -
        -
        -
        -
        - -

        services

        - - -
        -
        -

        BNet doesn't use this data yet, but it appears to be an optional list of flavor - text about services that the Vendor can provide.

        -
        -
        -
        -
        - -

        unlockRanges

        -
        unlockRanges: IDateRange[]
        - -
        -
        -

        If we were able to predict the dates when this Vendor will be visible/available, - this will be the list of those date ranges. Sadly, we're not able to predict - this very frequently, so this will often be useless data.

        -
        -
        -
        -
        - -

        vendorBanner

        -
        vendorBanner: string
        - -
        -
        -

        If the vendor has a custom banner image, that can be found here.

        -
        -
        -
        -
        - -

        vendorIdentifier

        -
        vendorIdentifier: string
        - -
        -
        -

        The internal identifier for the Vendor. A holdover from the old days of Vendors, - but we don't have time to refactor it away.

        -
        -
        -
        -
        - -

        vendorPortrait

        -
        vendorPortrait: string
        - -
        -
        -

        A portrait of the Vendor's smiling mug. Or frothing tentacles.

        -
        -
        -
        -
        - -

        vendorSubcategoryIdentifier

        -
        vendorSubcategoryIdentifier: string
        - -
        -
        -

        The identifier of the VendorCategoryDefinition for this vendor's subcategory.

        -
        -
        -
        -
        - -

        visible

        -
        visible: boolean
        - -
        -
        -

        If a vendor is not visible, we still have and will give vendor definition info, - but we won't use them for things like Advisors or UI.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendordisplaypropertiesdefinition.html b/docs/interfaces/idestinyvendordisplaypropertiesdefinition.html deleted file mode 100644 index 37badb8..0000000 --- a/docs/interfaces/idestinyvendordisplaypropertiesdefinition.html +++ /dev/null @@ -1,382 +0,0 @@ - - - - - - IDestinyVendorDisplayPropertiesDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorDisplayPropertiesDefinition

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorDisplayPropertiesDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        description

        -
        description: string
        - -
        -
        - -

        hasIcon

        -
        hasIcon: boolean
        - -
        -
        - -

        icon

        -
        icon: string
        - -
        -
        -

        Note that "icon" is sometimes misleading, and should be interpreted in the - context of the entity. For instance, in Destiny 1 the - DestinyRecordBookDefinition's icon was a big picture of a book.

        -
        -

        But usually, it will be a small square image that you can use as... well, an - icon.

        -
        -
        -
        - -

        largeIcon

        -
        largeIcon: string
        - -
        -
        -

        I regret calling this a "large icon". It's more like a medium-sized image with a - picture of the vendor's mug on it, trying their best to look cool. Not what one - would call an icon.

        -
        -
        -
        -
        - -

        largeTransparentIcon

        -
        largeTransparentIcon: string
        - -
        -
        -

        This is apparently the "Watermark". I am not certain offhand where this is - actually used in the Game UI, but some people may find it useful.

        -
        -
        -
        -
        - -

        mapIcon

        -
        mapIcon: string
        - -
        -
        -

        This is the icon used in the map overview, when the vendor is located on the map.

        -
        -
        -
        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        originalIcon

        -
        originalIcon: string
        - -
        -
        -

        If we replaced the icon with something more glitzy, this is the original icon - that the vendor had according to the game's content. It may be more lame and/or - have less razzle-dazzle. But who am I to tell you which icon to use.

        -
        -
        -
        -
        - -

        requirementsDisplay

        - - -
        -
        -

        Vendors, in addition to expected display property data, may also show some " - common requirements" as statically defined definition data. This might be when a - vendor accepts a single type of currency, or when the currency is unique to the - vendor and the designers wanted to show that currency when you interact with the - vendor.

        -
        -
        -
        -
        - -

        smallTransparentIcon

        -
        smallTransparentIcon: string
        - -
        -
        -

        This is the icon used in parts of the game UI such as the vendor's waypoint.

        -
        -
        -
        -
        - -

        subtitle

        -
        subtitle: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorgroup.html b/docs/interfaces/idestinyvendorgroup.html deleted file mode 100644 index f189143..0000000 --- a/docs/interfaces/idestinyvendorgroup.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - - IDestinyVendorGroup | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorGroup

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Represents a specific group of vendors that can be rendered in the recommended - order.

        -
        -

        How do we figure out this order? It's a long story, and will likely get more - complicated over time.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorGroup -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        vendorGroupHash

        -
        vendorGroupHash: number
        - -
        -
        -

        Mapped to IDestinyVendorGroupDefinition in the manifest.

        -
        -
        -
        -
        - -

        vendorHashes

        -
        vendorHashes: number[]
        - -
        -
        -

        The ordered list of vendors within a particular group.

        -
        -

        Mapped to IDestinyVendorDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorgroupcomponent.html b/docs/interfaces/idestinyvendorgroupcomponent.html deleted file mode 100644 index 2b5a803..0000000 --- a/docs/interfaces/idestinyvendorgroupcomponent.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IDestinyVendorGroupComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorGroupComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This component returns references to all of the Vendors in the response, grouped - by categorizations that Bungie has deemed to be interesting, in the order in - which both the groups and the vendors within that group should be rendered.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorGroupComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        groups

        - - -
        -
        -

        The ordered list of groups being returned.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorgroupdefinition.html b/docs/interfaces/idestinyvendorgroupdefinition.html deleted file mode 100644 index 493bffd..0000000 --- a/docs/interfaces/idestinyvendorgroupdefinition.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - IDestinyVendorGroupDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorGroupDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        BNet attempts to group vendors into similar collections. These groups aren't - technically game canonical, but they are helpful for filtering vendors or - showing them organized into a clean view on a webpage or app.

        -
        -

        These definitions represent the groups we've built. Unlike in Destiny 1, a - Vendors' group may change dynamically as the game state changes: thus, you will - want to check DestinyVendorComponent responses to find a vendor's currently - active Group (if you care).

        -

        Using this will let you group your vendors in your UI in a similar manner to how - we will do grouping in the Companion.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorGroupDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        categoryName

        -
        categoryName: string
        - -
        -
        -

        For now, a group just has a name.

        -
        -
        -
        -
        - -

        hash

        -
        hash: number
        - -
        -
        -

        The unique identifier for this entity. Guaranteed to be unique for the type of - entity, but not globally.

        -
        -

        When entities refer to each other in Destiny content, it is this hash that they - are referring to.

        -
        -
        -
        - -

        index

        -
        index: number
        - -
        -
        -

        The index of the entity as it was found in the investment tables.

        -
        -
        -
        -
        - -

        order

        -
        order: number
        - -
        -
        -

        The recommended order in which to render the groups, Ascending order.

        -
        -
        -
        -
        - -

        redacted

        -
        redacted: boolean
        - -
        -
        -

        If this is true, then there is an entity with this identifier/type combination, - but BNet is not yet allowed to show it. Sorry!

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorgroupreference.html b/docs/interfaces/idestinyvendorgroupreference.html deleted file mode 100644 index ae5fbf6..0000000 --- a/docs/interfaces/idestinyvendorgroupreference.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - - IDestinyVendorGroupReference | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorGroupReference

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorGroupReference -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        vendorGroupHash

        -
        vendorGroupHash: number
        - -
        -
        -

        The DestinyVendorGroupDefinition to which this Vendor can belong.

        -
        -

        Mapped to IDestinyVendorGroupDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorinteractiondefinition.html b/docs/interfaces/idestinyvendorinteractiondefinition.html deleted file mode 100644 index d2e23d1..0000000 --- a/docs/interfaces/idestinyvendorinteractiondefinition.html +++ /dev/null @@ -1,451 +0,0 @@ - - - - - - IDestinyVendorInteractionDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorInteractionDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A Vendor Interaction is a dialog shown by the vendor other than sale items or - transfer screens. The vendor is showing you something, and asking you to reply - to it by choosing an option or reward.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorInteractionDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        flavorLineOne

        -
        flavorLineOne: string
        - -
        -
        -

        If the vendor interaction has flavor text, this is some of it.

        -
        -
        -
        -
        - -

        flavorLineTwo

        -
        flavorLineTwo: string
        - -
        -
        -

        If the vendor interaction has flavor text, this is the rest of it.

        -
        -
        -
        -
        - -

        headerDisplayProperties

        -
        headerDisplayProperties: IDestinyDisplayPropertiesDefinition
        - -
        -
        -

        The header for the interaction dialog.

        -
        -
        -
        -
        - -

        instructions

        -
        instructions: string
        - -
        -
        -

        The localized text telling the player what to do when they see this dialog.

        -
        -
        -
        -
        - -

        interactionIndex

        -
        interactionIndex: number
        - -
        -
        -

        The position of this interaction in its parent array. Note that this is NOT - content agnostic, and should not be used as such.

        -
        -
        -
        -
        - -

        interactionType

        -
        interactionType: VendorInteractionType
        - -
        -
        -

        The enumerated version of the possible UI hints for vendor interactions, which - is a little easier to grok than the hash found in uiInteractionType.

        -
        -
        -
        -
        - -

        questlineItemHash

        -
        questlineItemHash: number
        - -
        -
        -

        If this interaction dialog is about a quest, this is the questline related to - the interaction. You can use this to show the quest overview, or even the - character's status with the quest if you use it to find the character's current - Quest Step by checking their inventory against this questlineItemHash's - DestinyInventoryItemDefinition.setData.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        replies

        - - -
        -
        -

        The potential replies that the user can make to the interaction.

        -
        -
        -
        -
        - -

        rewardBlockLabel

        -
        rewardBlockLabel: string
        - -
        -
        -

        If this interaction is displaying rewards, this is the text to use for the - header of the reward-displaying section of the interaction.

        -
        -
        -
        -
        - -

        rewardVendorCategoryIndex

        -
        rewardVendorCategoryIndex: number
        - -
        -
        -

        If the vendor's reward list is sourced from one of his categories, this is the - index into the category array of items to show.

        -
        -
        -
        -
        - -

        sackInteractionList

        - - -
        -
        -

        If this interaction is meant to show you sacks, this is the list of types of - sacks to be shown. If empty, the interaction is not meant to show sacks.

        -
        -
        -
        -
        - -

        uiInteractionType

        -
        uiInteractionType: number
        - -
        -
        -

        A UI hint for the behavior of the interaction screen. This is useful to - determine what type of interaction is occurring, such as a prompt to receive a - rank up reward or a prompt to choose a reward for completing a quest. The hash - isn't as useful as the Enum in retrospect, well what can you do. Try using - interactionType instead.

        -
        -
        -
        -
        - -

        vendorCategoryIndex

        -
        vendorCategoryIndex: number
        - -
        -
        -

        If >= 0, this is the category of sale items to show along with this interaction - dialog.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorinteractionreplydefinition.html b/docs/interfaces/idestinyvendorinteractionreplydefinition.html deleted file mode 100644 index a4332f9..0000000 --- a/docs/interfaces/idestinyvendorinteractionreplydefinition.html +++ /dev/null @@ -1,247 +0,0 @@ - - - - - - IDestinyVendorInteractionReplyDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorInteractionReplyDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        When the interaction is replied to, Reward sites will fire and items potentially - selected based on whether the given unlock expression is TRUE.

        -
        -

        You can potentially choose one from multiple replies when replying to an - interaction: this is how you get either/or rewards from vendors.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorInteractionReplyDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        itemRewardsSelection

        - - -
        -
        -

        The rewards granted upon responding to the vendor.

        -
        -
        -
        -
        - -

        reply

        -
        reply: string
        - -
        -
        -

        The localized text for the reply.

        -
        -
        -
        -
        - -

        replyType

        - - -
        -
        -

        An enum indicating the type of reply being made.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorinteractionsackentrydefinition.html b/docs/interfaces/idestinyvendorinteractionsackentrydefinition.html deleted file mode 100644 index e34371f..0000000 --- a/docs/interfaces/idestinyvendorinteractionsackentrydefinition.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - - - IDestinyVendorInteractionSackEntryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorInteractionSackEntryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Compare this sackType to the sack identifier in the - DestinyInventoryItemDefinition.vendorSackType property of items. If they match, - show this sack with this interaction.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorInteractionSackEntryDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        sackType

        -
        sackType: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorinventoryflyoutbucketdefinition.html b/docs/interfaces/idestinyvendorinventoryflyoutbucketdefinition.html deleted file mode 100644 index 83c9c41..0000000 --- a/docs/interfaces/idestinyvendorinventoryflyoutbucketdefinition.html +++ /dev/null @@ -1,246 +0,0 @@ - - - - - - IDestinyVendorInventoryFlyoutBucketDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorInventoryFlyoutBucketDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Information about a single inventory bucket in a vendor flyout UI and how it is - shown.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorInventoryFlyoutBucketDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        collapsible

        -
        collapsible: boolean
        - -
        -
        -

        If true, the inventory bucket should be able to be collapsed visually.

        -
        -
        -
        -
        - -

        inventoryBucketHash

        -
        inventoryBucketHash: number
        - -
        -
        -

        The inventory bucket whose contents should be shown.

        -
        -

        Mapped to IDestinyInventoryBucketDefinition in the manifest.

        -
        -
        -
        - -

        sortItemsBy

        -
        sortItemsBy: DestinyItemSortType
        - -
        -
        -

        The methodology to use for sorting items from the flyout.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorinventoryflyoutdefinition.html b/docs/interfaces/idestinyvendorinventoryflyoutdefinition.html deleted file mode 100644 index f3b1a0e..0000000 --- a/docs/interfaces/idestinyvendorinventoryflyoutdefinition.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - IDestinyVendorInventoryFlyoutDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorInventoryFlyoutDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The definition for an "inventory flyout": a UI screen where we show you part of - an otherwise hidden vendor inventory: like the Vault inventory buckets.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorInventoryFlyoutDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        buckets

        - - -
        -
        -

        A list of inventory buckets and other metadata to show on the screen.

        -
        -
        -
        -
        - -

        displayProperties

        - - -
        -
        -

        The title and other common properties of the flyout.

        -
        -
        -
        -
        - -

        Optional equipmentSlotHash

        -
        equipmentSlotHash: number
        - -
        -
        -

        If this flyout is meant to show you the contents of the player's equipment slot, - this is the slot to show.

        -
        -
        -
        -
        - -

        flyoutId

        -
        flyoutId: number
        - -
        -
        -

        An identifier for the flyout, in case anything else needs to refer to them.

        -
        -
        -
        -
        - -

        lockedDescription

        -
        lockedDescription: string
        - -
        -
        -

        If the flyout is locked, this is the reason why.

        -
        -
        -
        -
        - -

        suppressNewness

        -
        suppressNewness: boolean
        - -
        -
        -

        If this is true, don't show any of the glistening "this is a new item" UI - elements, like we show on the inventory items themselves in in-game UI.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendoritemdefinition.html b/docs/interfaces/idestinyvendoritemdefinition.html deleted file mode 100644 index 119006d..0000000 --- a/docs/interfaces/idestinyvendoritemdefinition.html +++ /dev/null @@ -1,687 +0,0 @@ - - - - - - IDestinyVendorItemDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorItemDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This represents an item being sold by the vendor.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorItemDefinition -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        action

        - - -
        -
        -

        The action to be performed when purchasing the item, if it's not just "buy".

        -
        -
        -
        -
        - -

        categoryIndex

        -
        categoryIndex: number
        - -
        -
        -

        The index into the DestinyVendorDefinition.categories array, so you can find the - category associated with this item.

        -
        -
        -
        -
        - -

        creationLevels

        - - -
        -
        -

        The Default level at which the item will spawn. Almost always driven by an - adjusto these days. Ideally should be singular. It's a long story how this ended - up as a list, but there is always either going to be 0:1 of these entities.

        -
        -
        -
        -
        - -

        currencies

        - - -
        -
        -

        This is a pre-compiled aggregation of item value and priceOverrideList, so that - we have one place to check for what the purchaser must pay for the item. Use - this instead of trying to piece together the price separately.

        -
        -

        The somewhat crappy part about this is that, now that item quantity overrides - have dynamic modifiers, this will not necessarily be statically true. If you - were using this instead of live data, switch to using live data.

        -
        -
        -
        - -

        displayCategory

        -
        displayCategory: string
        - -
        -
        -

        The string identifier for the category selling this item.

        -
        -
        -
        -
        - -

        displayCategoryIndex

        -
        displayCategoryIndex: number
        - -
        -
        -

        This is an index specifically into the display category, as opposed to the - server-side Categories (which do not need to match or pair with each other in - any way: server side categories are really just structures for common validation. - Display Category will let us more easily categorize items visually)

        -
        -
        -
        -
        - -

        exclusivity

        - - -
        -
        -

        If this item can only be purchased by a given platform, this indicates the - platform to which it is restricted.

        -
        -
        -
        -
        - -

        expirationTooltip

        -
        expirationTooltip: string
        - -
        -
        -

        If this item can expire, this is the tooltip message to show with its expiration - info.

        -
        -
        -
        -
        - -

        failureIndexes

        -
        failureIndexes: number[]
        - -
        -
        -

        An list of indexes into the DestinyVendorDefinition.failureStrings array, - indicating the possible failure strings that can be relevant for this item.

        -
        -
        -
        -
        - -

        inventoryBucketHash

        -
        inventoryBucketHash: number
        - -
        -
        -

        The inventory bucket into which this item will be placed upon purchase.

        -
        -
        -
        -
        - -

        Optional isCrm

        -
        isCrm: boolean
        - -
        -
        -

        If this sale can only be performed as the result of receiving a CRM offer, this - is true.

        -
        -
        -
        -
        - -

        Optional isOffer

        -
        isOffer: boolean
        - -
        -
        -

        If this sale can only be performed as the result of an offer check, this is true.

        -
        -
        -
        -
        - -

        itemHash

        -
        itemHash: number
        - -
        -
        -

        The hash identifier of the item being sold (DestinyInventoryItemDefinition).

        -
        -

        Note that a vendor can sell the same item in multiple ways, so don't assume that - itemHash is a unique identifier for this entity.

        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        maximumLevel

        -
        maximumLevel: number
        - -
        -
        -

        The maximum character level at which this item is available for sale.

        -
        -
        -
        -
        - -

        minimumLevel

        -
        minimumLevel: number
        - -
        -
        -

        The minimum character level at which this item is available for sale.

        -
        -
        -
        -
        - -

        originalCategoryIndex

        -
        originalCategoryIndex: number
        - -
        -
        -

        Same as above, but for the original category indexes.

        -
        -
        -
        -
        - -

        purchasableScope

        -
        purchasableScope: DestinyGatingScope
        - -
        -
        -

        Similar to visibilityScope, it represents the most restrictive scope that - determines whether the item can be purchased. It will at least be as restrictive - as visibilityScope, but could be more restrictive if the item has additional - purchase requirements beyond whether it is merely visible or not.

        -
        -

        See DestinyGatingScope's documentation for more information.

        -
        -
        -
        - -

        quantity

        -
        quantity: number
        - -
        -
        -

        The amount you will recieve of the item described in itemHash if you make the - purchase.

        -
        -
        -
        -
        - -

        redirectToSaleIndexes

        -
        redirectToSaleIndexes: number[]
        - -
        -
        -

        If this is populated, the purchase of this item should redirect to purchasing - these other items instead.

        -
        -
        -
        -
        - -

        refundPolicy

        - - -
        -
        -

        If this item can be refunded, this is the policy for what will be refundd, how, - and in what time period.

        -
        -
        -
        -
        - -

        refundTimeLimit

        -
        refundTimeLimit: number
        - -
        -
        -

        The amount of time before refundability of the newly purchased item will expire.

        -
        -
        -
        -
        - -

        socketOverrides

        - - -
        -
        - -

        sortValue

        -
        sortValue: number
        - -
        -
        -

        if the category this item is in supports non-default sorting, this value - should represent the sorting value to use, pre-processed and ready to go.

        -
        -
        -
        -
        - -

        vendorItemIndex

        -
        vendorItemIndex: number
        - -
        -
        -

        The index into the DestinyVendorDefinition.saleList. This is what we use to - refer to items being sold throughout live and definition data.

        -
        -
        -
        -
        - -

        visibilityScope

        -
        visibilityScope: DestinyGatingScope
        - -
        -
        -

        The most restrictive scope that determines whether the item is available in the - Vendor's inventory. See DestinyGatingScope's documentation for more information.

        -
        -

        This can be determined by Unlock gating, or by whether or not the item has - purchase level requirements (minimumLevel and maximumLevel properties).

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendoritemquantity.html b/docs/interfaces/idestinyvendoritemquantity.html deleted file mode 100644 index bce4bc6..0000000 --- a/docs/interfaces/idestinyvendoritemquantity.html +++ /dev/null @@ -1,251 +0,0 @@ - - - - - - IDestinyVendorItemQuantity | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorItemQuantity

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        In addition to item quantity information for vendor prices, this also has any - optional information that may exist about how the item's quantity can be - modified. (unfortunately not information that is able to be read outside of the - BNet servers, but it's there)

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorItemQuantity -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        itemHash

        -
        itemHash: number
        - -
        -
        -

        The hash identifier for the item in question. Use it to look up the item's - DestinyInventoryItemDefinition.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        Optional itemInstanceId

        -
        itemInstanceId: string
        - -
        -
        -

        If this quantity is referring to a specific instance of an item, this will have - the item's instance ID. Normally, this will be null.

        -
        -
        -
        -
        - -

        quantity

        -
        quantity: number
        - -
        -
        -

        The amount of the item needed/available depending on the context of where - DestinyItemQuantity is being used.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendoritemsocketoverride.html b/docs/interfaces/idestinyvendoritemsocketoverride.html deleted file mode 100644 index 1de7a56..0000000 --- a/docs/interfaces/idestinyvendoritemsocketoverride.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - - - IDestinyVendorItemSocketOverride | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorItemSocketOverride

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The information for how the vendor purchase should override a given socket with - custom plug data.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorItemSocketOverride -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        randomizedOptionsCount

        -
        randomizedOptionsCount: number
        - -
        -
        -

        If this is greater than -1, the number of randomized plugs on this socket will - be set to this quantity instead of whatever it's set to by default.

        -
        -
        -
        -
        - -

        Optional singleItemHash

        -
        singleItemHash: number
        - -
        -
        -

        If this is populated, the socket will be overridden with a specific plug.

        -
        -

        If this isn't populated, it's being overridden by something more complicated - that is only known by the Game Server and God, which means we can't tell you in - advance what it'll be.

        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        socketTypeHash

        -
        socketTypeHash: number
        - -
        -
        -

        This appears to be used to select which socket ultimately gets the override - defined here.

        -
        -

        Mapped to IDestinySocketTypeDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorlocationdefinition.html b/docs/interfaces/idestinyvendorlocationdefinition.html deleted file mode 100644 index 42abeb4..0000000 --- a/docs/interfaces/idestinyvendorlocationdefinition.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - - IDestinyVendorLocationDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorLocationDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        These definitions represent vendors' locations and relevant display information - at different times in the game.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorLocationDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        backgroundImagePath

        -
        backgroundImagePath: string
        - -
        -
        -

        The relative path to the background image representing this Vendor at this - location, for use in a banner.

        -
        -
        -
        -
        - -

        destinationHash

        -
        destinationHash: number
        - -
        -
        -

        The hash identifier for a Destination at which this vendor may be located. Each - destination where a Vendor may exist will only ever have a single entry.

        -
        -

        Mapped to IDestinyDestinationDefinition in the manifest.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorreceipt.html b/docs/interfaces/idestinyvendorreceipt.html deleted file mode 100644 index 5693613..0000000 --- a/docs/interfaces/idestinyvendorreceipt.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - IDestinyVendorReceipt | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorReceipt

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        If a character purchased an item that is refundable, a Vendor Receipt will be - created on the user's Destiny Profile. These expire after a configurable period - of time, but until then can be used to get refunds on items. BNet does not - provide the ability to refund a purchase yet, but you know.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorReceipt -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        currencyPaid

        -
        currencyPaid: IDestinyItemQuantity[]
        - -
        -
        -

        The amount paid for the item, in terms of items that were consumed in the - purchase and their quantity.

        -
        -
        -
        -
        - -

        expiresOn

        -
        expiresOn: string
        - -
        -
        -

        The date at which this receipt is rendered invalid.

        -
        -
        -
        -
        - -

        itemReceived

        -
        itemReceived: IDestinyItemQuantity
        - -
        -
        -

        The item that was received, and its quantity.

        -
        -
        -
        -
        - -

        licenseUnlockHash

        -
        licenseUnlockHash: number
        - -
        -
        -

        The unlock flag used to determine whether you still have the purchased item.

        -
        -
        -
        -
        - -

        purchasedByCharacterId

        -
        purchasedByCharacterId: string
        - -
        -
        -

        The ID of the character who made the purchase.

        -
        -
        -
        -
        - -

        refundPolicy

        - - -
        -
        -

        Whether you can get a refund, and what happens in order for the refund to be - received. See the DestinyVendorItemRefundPolicy enum for details.

        -
        -
        -
        -
        - -

        sequenceNumber

        -
        sequenceNumber: number
        - -
        -
        -

        The identifier of this receipt.

        -
        -
        -
        -
        - -

        timeToExpiration

        -
        timeToExpiration: string
        - -
        -
        -

        The seconds since epoch at which this receipt is rendered invalid.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorreceiptscomponent.html b/docs/interfaces/idestinyvendorreceiptscomponent.html deleted file mode 100644 index 28620ce..0000000 --- a/docs/interfaces/idestinyvendorreceiptscomponent.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IDestinyVendorReceiptsComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorReceiptsComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        For now, this isn't used for much: it's a record of the recent refundable - purchases that the user has made. In the future, it could be used for providing - refunds/buyback via the API. Wouldn't that be fun?

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorReceiptsComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        receipts

        - - -
        -
        -

        The receipts for refundable purchases made at a vendor.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorrequirementdisplayentrydefinition.html b/docs/interfaces/idestinyvendorrequirementdisplayentrydefinition.html deleted file mode 100644 index 727d351..0000000 --- a/docs/interfaces/idestinyvendorrequirementdisplayentrydefinition.html +++ /dev/null @@ -1,244 +0,0 @@ - - - - - - IDestinyVendorRequirementDisplayEntryDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorRequirementDisplayEntryDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The localized properties of the requirementsDisplay, allowing information about - the requirement or item being featured to be seen.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorRequirementDisplayEntryDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        icon

        -
        icon: string
        - -
        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        source

        -
        source: string
        - -
        -
        - -

        type

        -
        type: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorresponse.html b/docs/interfaces/idestinyvendorresponse.html deleted file mode 100644 index 2acd50a..0000000 --- a/docs/interfaces/idestinyvendorresponse.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - IDestinyVendorResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorResponse

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A response containing all of the components for a vendor.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        categories

        - - -
        -
        -

        Categories that the vendor has available, and references to the sales therein.

        -
        -

        COMPONENT TYPE: VendorCategories

        -
        -
        -
        - -

        currencyLookups

        - - -
        -
        -

        A "lookup" convenience component that can be used to quickly check if the - character has access to items that can be used for purchasing.

        -
        -

        COMPONENT TYPE: CurrencyLookups

        -
        -
        -
        - -

        itemComponents

        - - -
        -
        -

        Item components, keyed by the vendorItemIndex of the active sale items.

        -
        -

        COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component - types.]

        -
        -
        -
        - -

        sales

        - - -
        -
        -

        Sales, keyed by the vendorItemIndex of the item being sold.

        -
        -

        COMPONENT TYPE: VendorSales

        -
        -
        -
        - -

        vendor

        - - -
        -
        -

        The base properties of the vendor.

        -
        -

        COMPONENT TYPE: Vendors

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorsaleitemactionblockdefinition.html b/docs/interfaces/idestinyvendorsaleitemactionblockdefinition.html deleted file mode 100644 index d154925..0000000 --- a/docs/interfaces/idestinyvendorsaleitemactionblockdefinition.html +++ /dev/null @@ -1,215 +0,0 @@ - - - - - - IDestinyVendorSaleItemActionBlockDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorSaleItemActionBlockDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Not terribly useful, some basic cooldown interaction info.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorSaleItemActionBlockDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        executeSeconds

        -
        executeSeconds: number
        - -
        -
        - -

        isPositive

        -
        isPositive: boolean
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorsaleitemcomponent.html b/docs/interfaces/idestinyvendorsaleitemcomponent.html deleted file mode 100644 index 504b2e6..0000000 --- a/docs/interfaces/idestinyvendorsaleitemcomponent.html +++ /dev/null @@ -1,440 +0,0 @@ - - - - - - IDestinyVendorSaleItemComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorSaleItemComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Request this component if you want the details about an item being sold in - relation to the character making the request: whether the character can buy it, - whether they can afford it, and other data related to purchasing the item.

        -
        -

        Note that if you want instance, stats, etc... data for the item, you'll have to - request additional components such as ItemInstances, ItemPerks etc... and - acquire them from the DestinyVendorResponse's "items" property.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorSaleItemComponent -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        augments

        - - -
        -
        -

        A flags enumeration value representing the current state of any "state modifiers" - on the item being sold. These are meant to correspond with some sort of visual - indicator as to the augmentation: for instance, if an item is on sale or if you - already own the item in question.

        -
        -

        Determining how you want to represent these in your own app (or if you even want - to) is an exercise left for the reader.

        -
        -
        -
        - -

        costs

        - - -
        -
        -

        A summary of the current costs of the item.

        -
        -
        -
        -
        - -

        failureIndexes

        -
        failureIndexes: number[]
        - -
        -
        -

        Indexes in to the "failureStrings" lookup table in DestinyVendorDefinition for - the given Vendor. Gives some more reliable failure information for why you can't - purchase an item.

        -
        -

        It is preferred to use these over requiredUnlocks and unlockStatuses: the latter - are provided mostly in case someone can do something interesting with it that I - didn't anticipate.

        -
        -
        -
        - -

        itemHash

        -
        itemHash: number
        - -
        -
        -

        The hash of the item being sold, as a quick shortcut for looking up the - DestinyInventoryItemDefinition of the sale item.

        -
        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        Optional overrideNextRefreshDate

        -
        overrideNextRefreshDate: string
        - -
        -
        -

        If this item has its own custom date where it may be removed from the Vendor's - rotation, this is that date.

        -
        -

        Note that there's not actually any guarantee that it will go away: it could be - chosen again and end up still being in the Vendor's sale items! But this is the - next date where that test will occur, and is also the date that the game shows - for availability on things like Bounties being sold. So it's the best we can - give.

        -
        -
        -
        - -

        Optional overrideStyleItemHash

        -
        overrideStyleItemHash: number
        - -
        -
        -

        If populated, this is the hash of the item whose icon (and other secondary - styles, but not the human readable strings) should override whatever icons/ - styles are on the item being sold.

        -
        -

        If you don't do this, certain items whose styles are being overridden by - socketed items - such as the "Recycle Shader" item - would show whatever their - default icon/style is, and it wouldn't be pretty or look accurate.

        -

        Mapped to IDestinyInventoryItemDefinition in the manifest.

        -
        -
        -
        - -

        quantity

        -
        quantity: number
        - -
        -
        -

        How much of the item you'll be getting.

        -
        -
        -
        -
        - -

        requiredUnlocks

        -
        requiredUnlocks: number[]
        - -
        -
        -

        If you can't buy the item due to a complex character state, these will be hashes - for DestinyUnlockDefinitions that you can check to see messages regarding the - failure (if the unlocks have human readable information: it is not guaranteed - that Unlocks will have human readable strings, and your application will have to - handle that)

        -
        -

        Prefer using failureIndexes instead. These are provided for informational - purposes, but have largely been supplanted by failureIndexes.

        -

        Mapped to IDestinyUnlockDefinition in the manifest.

        -
        -
        -
        - -

        saleStatus

        -
        saleStatus: VendorItemStatus
        - -
        -
        -

        A flag indicating whether the requesting character can buy the item, and if not - the reasons why the character can't buy it.

        -
        -
        -
        -
        - -

        unlockStatuses

        -
        unlockStatuses: IDestinyUnlockStatus[]
        - -
        -
        -

        If any complex unlock states are checked in determining purchasability, these - will be returned here along with the status of the unlock check.

        -
        -

        Prefer using failureIndexes instead. These are provided for informational - purposes, but have largely been supplanted by failureIndexes.

        -
        -
        -
        - -

        vendorItemIndex

        -
        vendorItemIndex: number
        - -
        -
        -

        The index into the DestinyVendorDefinition.itemList property. Note that this - means Vendor data is Content Version dependent: make sure you have the latest - content before you use Vendor data, or these indexes may mismatch.

        -
        -

        Most systems avoid this problem, but Vendors is one area where we are unable to - reasonably avoid content dependency at the moment.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorsaleitemsetcomponent.html b/docs/interfaces/idestinyvendorsaleitemsetcomponent.html deleted file mode 100644 index f37f9bc..0000000 --- a/docs/interfaces/idestinyvendorsaleitemsetcomponent.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - - IDestinyVendorSaleItemSetComponent | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorSaleItemSetComponent

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The collection of all items currently being sold by a specific Vendor and - visible to the given character for which the request was made.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorSaleItemSetComponent -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        saleItems

        -
        saleItems: object
        - -
        -
        -

        The items being sold by this vendor, keyed by the vendorItemIndex of the item - being sold. (because showing sale items depends on the ordering dictated by the - categories being shown - see DestinyVendorCategoryComponent - this is a - dictionary for quick lookup capability.)

        -
        -
        -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorservicedefinition.html b/docs/interfaces/idestinyvendorservicedefinition.html deleted file mode 100644 index 1ab4f4d..0000000 --- a/docs/interfaces/idestinyvendorservicedefinition.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - - IDestinyVendorServiceDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorServiceDefinition

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        When a vendor provides services, this is the localized name of those services.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorServiceDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        name

        -
        name: string
        - -
        -
        -

        The localized name of a service provided.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idestinyvendorsresponse.html b/docs/interfaces/idestinyvendorsresponse.html deleted file mode 100644 index 2627e2a..0000000 --- a/docs/interfaces/idestinyvendorsresponse.html +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - IDestinyVendorsResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDestinyVendorsResponse

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A response containing all of the components for all requested vendors.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDestinyVendorsResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        categories

        - - -
        -
        -

        Categories that the vendor has available, and references to the sales therein. - These are keyed by the Vendor Hash, so you will get one Categories Component per - vendor returned.

        -
        -

        COMPONENT TYPE: VendorCategories

        -
        -
        -
        - -

        currencyLookups

        - - -
        -
        -

        A "lookup" convenience component that can be used to quickly check if the - character has access to items that can be used for purchasing.

        -
        -

        COMPONENT TYPE: CurrencyLookups

        -
        -
        -
        - -

        itemComponents

        -
        itemComponents: object
        - -
        -
        -

        The set of item detail components, one set of item components per Vendor. These - are keyed by the Vendor Hash, so you will get one Item Component Set per vendor - returned.

        -
        -

        The components contained inside are themselves keyed by the vendorSaleIndex, and - will have whatever item-level components you requested (Sockets, Stats, Instance - data etc...) per item being sold by the vendor.

        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        sales

        - - -
        -
        -

        Sales, keyed by the vendorItemIndex of the item being sold. These are keyed by - the Vendor Hash, so you will get one Sale Item Set Component per vendor returned.

        -
        -

        Note that within the Sale Item Set component, the sales are themselves keyed by - the vendorSaleIndex, so you can relate it to the corrent sale item definition - within the Vendor's definition.

        -

        COMPONENT TYPE: VendorSales

        -
        -
        -
        - -

        vendorGroups

        - - -
        -
        -

        For Vendors being returned, this will give you the information you need to group - them and order them in the same way that the Bungie Companion app performs - grouping. It will automatically be returned if you request the Vendors component.

        -
        -

        COMPONENT TYPE: Vendors

        -
        -
        -
        - -

        vendors

        - - -
        -
        -

        The base properties of the vendor. These are keyed by the Vendor Hash, so you - will get one Vendor Component per vendor returned.

        -
        -

        COMPONENT TYPE: Vendors

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idictionarycomponentresponse.html b/docs/interfaces/idictionarycomponentresponse.html deleted file mode 100644 index 3c5f449..0000000 --- a/docs/interfaces/idictionarycomponentresponse.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - IDictionaryComponentResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDictionaryComponentResponse<T>

        -
        -
        -
        -
        -
        -
        -
        -

        Type parameters

        -
          -
        • -

          T

          -
        • -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDictionaryComponentResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        data

        -
        data: object
        - -
        -

        Type declaration

        -
          -
        • -
          [key: string]: T
          -
        • -
        -
        -
        -
        - -

        privacy

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idictionaryresponse.html b/docs/interfaces/idictionaryresponse.html deleted file mode 100644 index d5dd424..0000000 --- a/docs/interfaces/idictionaryresponse.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - IDictionaryResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDictionaryResponse<S>

        -
        -
        -
        -
        -
        -
        -
        -

        Type parameters

        -
          -
        • -

          S

          -
        • -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDictionaryResponse -
        • -
        -
        -
        -

        Indexable

        -
        [key: string]: S
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/idyereference.html b/docs/interfaces/idyereference.html deleted file mode 100644 index 3462ba0..0000000 --- a/docs/interfaces/idyereference.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IDyeReference | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IDyeReference

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IDyeReference -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        channelHash

        -
        channelHash: number
        - -
        -
        - -

        dyeHash

        -
        dyeHash: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/ientityactionresult.html b/docs/interfaces/ientityactionresult.html deleted file mode 100644 index b58201e..0000000 --- a/docs/interfaces/ientityactionresult.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IEntityActionResult | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IEntityActionResult

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IEntityActionResult -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        entityId

        -
        entityId: string
        - -
        -
        - -

        result

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/ifireteammember.html b/docs/interfaces/ifireteammember.html deleted file mode 100644 index 38fb794..0000000 --- a/docs/interfaces/ifireteammember.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - IFireteamMember | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IFireteamMember

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IFireteamMember -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        bungieNetUserInfo

        -
        bungieNetUserInfo: IUserInfoCard
        - -
        -
        - -

        characterId

        -
        characterId: string
        - -
        -
        - -

        dateJoined

        -
        dateJoined: string
        - -
        -
        - -

        destinyUserInfo

        -
        destinyUserInfo: IUserInfoCard
        - -
        -
        - -

        hasMicrophone

        -
        hasMicrophone: boolean
        - -
        -
        - -

        lastPlatformInviteAttemptDate

        -
        lastPlatformInviteAttemptDate: string
        - -
        -
        - -

        lastPlatformInviteAttemptResult

        -
        lastPlatformInviteAttemptResult: FireteamPlatformInviteResult
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/ifireteamresponse.html b/docs/interfaces/ifireteamresponse.html deleted file mode 100644 index 1506aba..0000000 --- a/docs/interfaces/ifireteamresponse.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IFireteamResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IFireteamResponse

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IFireteamResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        Alternates

        -
        Alternates: IFireteamMember[]
        - -
        -
        - -

        Members

        -
        Members: IFireteamMember[]
        - -
        -
        - -

        Summary

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/ifireteamsummary.html b/docs/interfaces/ifireteamsummary.html deleted file mode 100644 index 50ebe19..0000000 --- a/docs/interfaces/ifireteamsummary.html +++ /dev/null @@ -1,432 +0,0 @@ - - - - - - IFireteamSummary | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IFireteamSummary

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IFireteamSummary -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        activityType

        -
        activityType: FireteamActivityType
        - -
        -
        - -

        Optional alternateSlotCount

        -
        alternateSlotCount: number
        - -
        -
        - -

        availableAlternateSlotCount

        -
        availableAlternateSlotCount: number
        - -
        -
        - -

        availablePlayerSlotCount

        -
        availablePlayerSlotCount: number
        - -
        -
        - -

        dateCreated

        -
        dateCreated: string
        - -
        -
        - -

        Optional dateModified

        -
        dateModified: string
        - -
        -
        - -

        datePlayerModified

        -
        datePlayerModified: string
        - -
        -
        - -

        fireteamId

        -
        fireteamId: string
        - -
        -
        - -

        groupId

        -
        groupId: string
        - -
        -
        - -

        isImmediate

        -
        isImmediate: boolean
        - -
        -
        - -

        isPublic

        -
        isPublic: boolean
        - -
        -
        - -

        isValid

        -
        isValid: boolean
        - -
        -
        - -

        locale

        -
        locale: string
        - -
        -
        - -

        ownerMembershipId

        -
        ownerMembershipId: string
        - -
        -
        - -

        platform

        - - -
        -
        - -

        playerSlotCount

        -
        playerSlotCount: number
        - -
        -
        - -

        Optional scheduledTime

        -
        scheduledTime: string
        - -
        -
        - -

        title

        -
        title: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iforumrecruitmentdetail.html b/docs/interfaces/iforumrecruitmentdetail.html deleted file mode 100644 index ea44fbd..0000000 --- a/docs/interfaces/iforumrecruitmentdetail.html +++ /dev/null @@ -1,320 +0,0 @@ - - - - - - IForumRecruitmentDetail | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IForumRecruitmentDetail

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IForumRecruitmentDetail -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        Fireteam

        -
        Fireteam: IGeneralUser[]
        - -
        -
        - -

        approved

        -
        approved: boolean
        - -
        -
        - -

        Optional conversationId

        -
        conversationId: string
        - -
        -
        - -

        intensity

        - - -
        -
        - -

        kickedPlayerIds

        -
        kickedPlayerIds: string[]
        - -
        -
        - -

        microphoneRequired

        -
        microphoneRequired: boolean
        - -
        -
        - -

        playerSlotsRemaining

        -
        playerSlotsRemaining: number
        - -
        -
        - -

        playerSlotsTotal

        -
        playerSlotsTotal: number
        - -
        -
        - -

        tone

        - - -
        -
        - -

        topicId

        -
        topicId: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igearassetdatabasedefinition.html b/docs/interfaces/igearassetdatabasedefinition.html deleted file mode 100644 index 557f924..0000000 --- a/docs/interfaces/igearassetdatabasedefinition.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IGearAssetDataBaseDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGearAssetDataBaseDefinition

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGearAssetDataBaseDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        path

        -
        path: string
        - -
        -
        - -

        version

        -
        version: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igeneraluser.html b/docs/interfaces/igeneraluser.html deleted file mode 100644 index 8e80d89..0000000 --- a/docs/interfaces/igeneraluser.html +++ /dev/null @@ -1,600 +0,0 @@ - - - - - - IGeneralUser | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGeneralUser

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGeneralUser -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        about

        -
        about: string
        - -
        -
        - -

        blizzardDisplayName

        -
        blizzardDisplayName: string
        - -
        -
        - -

        context

        - - -
        -
        - -

        displayName

        -
        displayName: string
        - -
        -
        - -

        fbDisplayName

        -
        fbDisplayName: string
        - -
        -
        - -

        Optional firstAccess

        -
        firstAccess: string
        - -
        -
        - -

        isDeleted

        -
        isDeleted: boolean
        - -
        -
        - -

        Optional lastBanReportId

        -
        lastBanReportId: string
        - -
        -
        - -

        Optional lastUpdate

        -
        lastUpdate: string
        - -
        -
        - -

        Optional legacyPortalUID

        -
        legacyPortalUID: string
        - -
        -
        - -

        locale

        -
        locale: string
        - -
        -
        - -

        localeInheritDefault

        -
        localeInheritDefault: boolean
        - -
        -
        - -

        membershipId

        -
        membershipId: string
        - -
        -
        - -

        normalizedName

        -
        normalizedName: string
        - -
        -
        - -

        Optional profileBanExpire

        -
        profileBanExpire: string
        - -
        -
        - -

        profilePicture

        -
        profilePicture: number
        - -
        -
        - -

        profilePicturePath

        -
        profilePicturePath: string
        - -
        -
        - -

        profilePictureWidePath

        -
        profilePictureWidePath: string
        - -
        -
        - -

        profileTheme

        -
        profileTheme: number
        - -
        -
        - -

        profileThemeName

        -
        profileThemeName: string
        - -
        -
        - -

        psnDisplayName

        -
        psnDisplayName: string
        - -
        -
        - -

        Optional showActivity

        -
        showActivity: boolean
        - -
        -
        - -

        showGroupMessaging

        -
        showGroupMessaging: boolean
        - -
        -
        - -

        statusDate

        -
        statusDate: string
        - -
        -
        - -

        statusText

        -
        statusText: string
        - -
        -
        - -

        successMessageFlags

        -
        successMessageFlags: string
        - -
        -
        - -

        uniqueName

        -
        uniqueName: string
        - -
        -
        - -

        userTitle

        -
        userTitle: number
        - -
        -
        - -

        userTitleDisplay

        -
        userTitleDisplay: string
        - -
        -
        - -

        xboxDisplayName

        -
        xboxDisplayName: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iglobalalert.html b/docs/interfaces/iglobalalert.html deleted file mode 100644 index 3e73c38..0000000 --- a/docs/interfaces/iglobalalert.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - IGlobalAlert | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGlobalAlert

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGlobalAlert -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        AlerTimestamp

        -
        AlerTimestamp: Date
        - -
        -
        - -

        AlertHtml

        -
        AlertHtml: string
        - -
        -
        - -

        AlertKey

        -
        AlertKey: string
        - -
        -
        - -

        AlertLevel

        -
        AlertLevel: GlobalAlertLevel
        - -
        -
        - -

        AlertLink

        -
        AlertLink: string
        - -
        -
        - -

        AlertType

        -
        AlertType: GlobalAlertType
        - -
        -
        - -

        StreamInfo

        -
        StreamInfo: IStreamInfo
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/ignoreresponse.html b/docs/interfaces/ignoreresponse.html new file mode 100644 index 0000000..fa59a75 --- /dev/null +++ b/docs/interfaces/ignoreresponse.html @@ -0,0 +1,227 @@ + + + + + + IgnoreResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface IgnoreResponse

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Bungie.Net API + These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.

        +
        +

        OpenAPI spec version: 2.3.5 + Contact: support@bungie.com

        +

        NOTE: This class is auto generated by the bungie-api-ts code generator program. + https://github.com/DestinyItemManager/bugie-api-ts + Do not edit these files manually.

        +
        +
        +
        +

        Hierarchy

        +
          +
        • + IgnoreResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        ignoreFlags

        +
        ignoreFlags: IgnoreStatus
        + +
        +
        +

        This enum represents a set of flags - use bitwise operators to check which of + these match your value.

        +
        +
        +
        +
        + +

        isIgnored

        +
        isIgnored: boolean
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/igroupaction.html b/docs/interfaces/igroupaction.html deleted file mode 100644 index 325016e..0000000 --- a/docs/interfaces/igroupaction.html +++ /dev/null @@ -1,443 +0,0 @@ - - - - - - IGroupAction | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupAction

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupAction -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        about

        -
        about: string
        - -
        -
        - -

        allowChat

        -
        allowChat: boolean
        - -
        -
        - -

        avatarImageIndex

        -
        avatarImageIndex: number
        - -
        -
        - -

        callsign

        -
        callsign: string
        - -
        -
        - -

        chatSecurity

        -
        chatSecurity: ChatSecuritySetting
        - -
        -
        - -

        groupType

        -
        groupType: GroupType
        - -
        -
        -

        Type of group, either Bungie.net hosted group, or a game services hosted clan.

        -
        -
        -
        -
        - -

        homepage

        -
        homepage: GroupHomepage
        - -
        -
        - -

        isDefaultPostAlliance

        -
        isDefaultPostAlliance: boolean
        - -
        -
        - -

        isDefaultPostPublic

        -
        isDefaultPostPublic: boolean
        - -
        -
        - -

        isPublic

        -
        isPublic: boolean
        - -
        -
        - -

        isPublicTopicAdminOnly

        -
        isPublicTopicAdminOnly: boolean
        - -
        -
        - -

        locale

        -
        locale: string
        - -
        -
        - -

        membershipOption

        -
        membershipOption: MembershipOption
        - -
        -
        - -

        motto

        -
        motto: string
        - -
        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        platformMembershipType

        -
        platformMembershipType: BungieMembershipType
        - -
        -
        -

        When operation needs a platform specific account ID for the present user, use - this property. In particular, groupType of Clan requires this value to be set.

        -
        -
        -
        -
        - -

        tags

        -
        tags: string
        - -
        -
        - -

        theme

        -
        theme: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupapplicationlistrequest.html b/docs/interfaces/igroupapplicationlistrequest.html deleted file mode 100644 index 309320a..0000000 --- a/docs/interfaces/igroupapplicationlistrequest.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IGroupApplicationListRequest | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupApplicationListRequest

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupApplicationListRequest -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        memberships

        -
        memberships: IUserMembership[]
        - -
        -
        - -

        message

        -
        message: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupapplicationrequest.html b/docs/interfaces/igroupapplicationrequest.html deleted file mode 100644 index 2b8e214..0000000 --- a/docs/interfaces/igroupapplicationrequest.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - IGroupApplicationRequest | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupApplicationRequest

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupApplicationRequest -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        message

        -
        message: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupapplicationresponse.html b/docs/interfaces/igroupapplicationresponse.html deleted file mode 100644 index 6a06d6d..0000000 --- a/docs/interfaces/igroupapplicationresponse.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - IGroupApplicationResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupApplicationResponse

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupApplicationResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        resolution

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupban.html b/docs/interfaces/igroupban.html deleted file mode 100644 index da64129..0000000 --- a/docs/interfaces/igroupban.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - IGroupBan | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupBan

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupBan -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        bungieNetUserInfo

        -
        bungieNetUserInfo: IUserInfoCard
        - -
        -
        - -

        comment

        -
        comment: string
        - -
        -
        - -

        createdBy

        -
        createdBy: IUserInfoCard
        - -
        -
        - -

        dateBanned

        -
        dateBanned: string
        - -
        -
        - -

        dateExpires

        -
        dateExpires: string
        - -
        -
        - -

        destinyUserInfo

        -
        destinyUserInfo: IUserInfoCard
        - -
        -
        - -

        groupId

        -
        groupId: string
        - -
        -
        - -

        lastModifiedBy

        -
        lastModifiedBy: IUserInfoCard
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupbanrequest.html b/docs/interfaces/igroupbanrequest.html deleted file mode 100644 index 5b14490..0000000 --- a/docs/interfaces/igroupbanrequest.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IGroupBanRequest | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupBanRequest

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupBanRequest -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        comment

        -
        comment: string
        - -
        -
        - -

        length

        -
        length: IgnoreLength
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupcreationresponse.html b/docs/interfaces/igroupcreationresponse.html deleted file mode 100644 index d2bf1ce..0000000 --- a/docs/interfaces/igroupcreationresponse.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - IGroupCreationResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupCreationResponse

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupCreationResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        groupId

        -
        groupId: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupeditaction.html b/docs/interfaces/igroupeditaction.html deleted file mode 100644 index 1a5e5a1..0000000 --- a/docs/interfaces/igroupeditaction.html +++ /dev/null @@ -1,404 +0,0 @@ - - - - - - IGroupEditAction | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupEditAction

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupEditAction -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        about

        -
        about: string
        - -
        -
        - -

        Optional allowChat

        -
        allowChat: boolean
        - -
        -
        - -

        Optional avatarImageIndex

        -
        avatarImageIndex: number
        - -
        -
        - -

        callsign

        -
        callsign: string
        - -
        -
        - -

        Optional chatSecurity

        -
        chatSecurity: number
        - -
        -
        - -

        Optional defaultPublicity

        -
        defaultPublicity: number
        - -
        -
        - -

        Optional enableInvitationMessagingForAdmins

        -
        enableInvitationMessagingForAdmins: boolean
        - -
        -
        - -

        Optional homepage

        -
        homepage: number
        - -
        -
        - -

        Optional isPublic

        -
        isPublic: boolean
        - -
        -
        - -

        Optional isPublicTopicAdminOnly

        -
        isPublicTopicAdminOnly: boolean
        - -
        -
        - -

        locale

        -
        locale: string
        - -
        -
        - -

        Optional membershipOption

        -
        membershipOption: number
        - -
        -
        - -

        motto

        -
        motto: string
        - -
        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        tags

        -
        tags: string
        - -
        -
        - -

        theme

        -
        theme: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupfeatures.html b/docs/interfaces/igroupfeatures.html deleted file mode 100644 index 0cfa747..0000000 --- a/docs/interfaces/igroupfeatures.html +++ /dev/null @@ -1,353 +0,0 @@ - - - - - - IGroupFeatures | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupFeatures

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupFeatures -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        capabilities

        -
        capabilities: Capabilities
        - -
        -
        - -

        hostGuidedGamePermissionOverride

        -
        hostGuidedGamePermissionOverride: HostGuidedGamesPermissionLevel
        - -
        -
        -

        Minimum Member Level allowed to host guided games

        -
        -

        Always Allowed: Founder, Acting Founder, Admin

        -

        Allowed Overrides: None, Member, Beginner

        -

        Default is Member for clans, None for groups, although this means nothing for - groups.

        -
        -
        -
        - -

        invitePermissionOverride

        -
        invitePermissionOverride: boolean
        - -
        -
        -

        Minimum Member Level allowed to invite new members to group

        -
        -

        Always Allowed: Founder, Acting Founder

        -

        True means admins have this power, false means they don't

        -

        Default is false for clans, true for groups.

        -
        -
        -
        - -

        joinLevel

        - - -
        -
        -

        Level to join a member at when accepting an invite, application, or joining an - open clan

        -
        -

        Default is Beginner.

        -
        -
        -
        - -

        maximumMembers

        -
        maximumMembers: number
        - -
        -
        - -

        maximumMembershipsOfGroupType

        -
        maximumMembershipsOfGroupType: number
        - -
        -
        -

        Maximum number of groups of this type a typical membership may join. For example, - a user may join about 50 General groups with their Bungie.net account. They may - join one clan per Destiny membership.

        -
        -
        -
        -
        - -

        membershipTypes

        -
        membershipTypes: BungieMembershipType[]
        - -
        -
        - -

        updateBannerPermissionOverride

        -
        updateBannerPermissionOverride: boolean
        - -
        -
        -

        Minimum Member Level allowed to update banner

        -
        -

        Always Allowed: Founder, Acting Founder

        -

        True means admins have this power, false means they don't

        -

        Default is false for clans, true for groups.

        -
        -
        -
        - -

        updateCulturePermissionOverride

        -
        updateCulturePermissionOverride: boolean
        - -
        -
        -

        Minimum Member Level allowed to update group culture

        -
        -

        Always Allowed: Founder, Acting Founder

        -

        True means admins have this power, false means they don't

        -

        Default is false for clans, true for groups.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupmember.html b/docs/interfaces/igroupmember.html deleted file mode 100644 index 5917d71..0000000 --- a/docs/interfaces/igroupmember.html +++ /dev/null @@ -1,264 +0,0 @@ - - - - - - IGroupMember | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupMember

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupMember -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        bungieNetUserInfo

        -
        bungieNetUserInfo: IUserInfoCard
        - -
        -
        - -

        destinyUserInfo

        -
        destinyUserInfo: IUserInfoCard
        - -
        -
        - -

        groupId

        -
        groupId: string
        - -
        -
        - -

        isOnline

        -
        isOnline: boolean
        - -
        -
        - -

        joinDate

        -
        joinDate: string
        - -
        -
        - -

        memberType

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupmemberapplication.html b/docs/interfaces/igroupmemberapplication.html deleted file mode 100644 index b5385fc..0000000 --- a/docs/interfaces/igroupmemberapplication.html +++ /dev/null @@ -1,306 +0,0 @@ - - - - - - IGroupMemberApplication | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupMemberApplication

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupMemberApplication -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        bungieNetUserInfo

        -
        bungieNetUserInfo: IUserInfoCard
        - -
        -
        - -

        creationDate

        -
        creationDate: string
        - -
        -
        - -

        destinyUserInfo

        -
        destinyUserInfo: IUserInfoCard
        - -
        -
        - -

        groupId

        -
        groupId: string
        - -
        -
        - -

        requestMessage

        -
        requestMessage: string
        - -
        -
        - -

        Optional resolveDate

        -
        resolveDate: string
        - -
        -
        - -

        resolveMessage

        -
        resolveMessage: string
        - -
        -
        - -

        resolveState

        - - -
        -
        - -

        Optional resolvedByMembershipId

        -
        resolvedByMembershipId: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupmemberleaveresult.html b/docs/interfaces/igroupmemberleaveresult.html deleted file mode 100644 index 489f583..0000000 --- a/docs/interfaces/igroupmemberleaveresult.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IGroupMemberLeaveResult | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupMemberLeaveResult

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupMemberLeaveResult -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        group

        -
        group: IGroupV2
        - -
        -
        - -

        groupDeleted

        -
        groupDeleted: boolean
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupmembership.html b/docs/interfaces/igroupmembership.html deleted file mode 100644 index ef2d2dc..0000000 --- a/docs/interfaces/igroupmembership.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IGroupMembership | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupMembership

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupMembership -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        group

        -
        group: IGroupV2
        - -
        -
        - -

        member

        -
        member: IGroupMember
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupmembershipsearchresponse.html b/docs/interfaces/igroupmembershipsearchresponse.html deleted file mode 100644 index 9c93df9..0000000 --- a/docs/interfaces/igroupmembershipsearchresponse.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - IGroupMembershipSearchResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupMembershipSearchResponse

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupMembershipSearchResponse -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        hasMore

        -
        hasMore: boolean
        - -
        -
        - -

        query

        - - -
        -
        - -

        replacementContinuationToken

        -
        replacementContinuationToken: string
        - -
        -
        - -

        results

        -
        results: IGroupMembership[]
        - -
        -
        - -

        totalResults

        -
        totalResults: number
        - -
        -
        - -

        useTotalResults

        -
        useTotalResults: boolean
        - -
        -
        -

        If useTotalResults is true, then totalResults represents an accurate count.

        -
        -

        If False, it does not, and may be estimated/only the size of the current page.

        -

        Either way, you should probably always only trust hasMore.

        -

        This is a long-held historical throwback to when we used to do paging with known - total results. Those queries toasted our database, and we were left to hastily - alter our endpoints and create backward- compatible shims, of which - useTotalResults is one.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupnamesearchrequest.html b/docs/interfaces/igroupnamesearchrequest.html deleted file mode 100644 index 29bb18c..0000000 --- a/docs/interfaces/igroupnamesearchrequest.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IGroupNameSearchRequest | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupNameSearchRequest

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupNameSearchRequest -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        groupName

        -
        groupName: string
        - -
        -
        - -

        groupType

        -
        groupType: GroupType
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupoptionalconversation.html b/docs/interfaces/igroupoptionalconversation.html deleted file mode 100644 index a31915e..0000000 --- a/docs/interfaces/igroupoptionalconversation.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - IGroupOptionalConversation | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupOptionalConversation

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupOptionalConversation -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        chatEnabled

        -
        chatEnabled: boolean
        - -
        -
        - -

        chatName

        -
        chatName: string
        - -
        -
        - -

        chatSecurity

        -
        chatSecurity: ChatSecuritySetting
        - -
        -
        - -

        conversationId

        -
        conversationId: string
        - -
        -
        - -

        groupId

        -
        groupId: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupoptionalconversationaddrequest.html b/docs/interfaces/igroupoptionalconversationaddrequest.html deleted file mode 100644 index 26e05e2..0000000 --- a/docs/interfaces/igroupoptionalconversationaddrequest.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IGroupOptionalConversationAddRequest | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupOptionalConversationAddRequest

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupOptionalConversationAddRequest -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        chatName

        -
        chatName: string
        - -
        -
        - -

        chatSecurity

        -
        chatSecurity: ChatSecuritySetting
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupoptionalconversationeditrequest.html b/docs/interfaces/igroupoptionalconversationeditrequest.html deleted file mode 100644 index 95459d7..0000000 --- a/docs/interfaces/igroupoptionalconversationeditrequest.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IGroupOptionalConversationEditRequest | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupOptionalConversationEditRequest

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupOptionalConversationEditRequest -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        Optional chatEnabled

        -
        chatEnabled: boolean
        - -
        -
        - -

        chatName

        -
        chatName: string
        - -
        -
        - -

        Optional chatSecurity

        -
        chatSecurity: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupoptionseditaction.html b/docs/interfaces/igroupoptionseditaction.html deleted file mode 100644 index 9c9fefe..0000000 --- a/docs/interfaces/igroupoptionseditaction.html +++ /dev/null @@ -1,290 +0,0 @@ - - - - - - IGroupOptionsEditAction | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupOptionsEditAction

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupOptionsEditAction -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        Optional HostGuidedGamePermissionOverride

        -
        HostGuidedGamePermissionOverride: number
        - -
        -
        -

        Minimum Member Level allowed to host guided games

        -
        -

        Always Allowed: Founder, Acting Founder, Admin

        -

        Allowed Overrides: None, Member, Beginner

        -

        Default is Member for clans, None for groups, although this means nothing for - groups.

        -
        -
        -
        - -

        Optional InvitePermissionOverride

        -
        InvitePermissionOverride: boolean
        - -
        -
        -

        Minimum Member Level allowed to invite new members to group

        -
        -

        Always Allowed: Founder, Acting Founder

        -

        True means admins have this power, false means they don't

        -

        Default is false for clans, true for groups.

        -
        -
        -
        - -

        Optional JoinLevel

        -
        JoinLevel: number
        - -
        -
        -

        Level to join a member at when accepting an invite, application, or joining an - open clan

        -
        -

        Default is Beginner.

        -
        -
        -
        - -

        Optional UpdateBannerPermissionOverride

        -
        UpdateBannerPermissionOverride: boolean
        - -
        -
        -

        Minimum Member Level allowed to update banner

        -
        -

        Always Allowed: Founder, Acting Founder

        -

        True means admins have this power, false means they don't

        -

        Default is false for clans, true for groups.

        -
        -
        -
        - -

        Optional UpdateCulturePermissionOverride

        -
        UpdateCulturePermissionOverride: boolean
        - -
        -
        -

        Minimum Member Level allowed to update group culture

        -
        -

        Always Allowed: Founder, Acting Founder

        -

        True means admins have this power, false means they don't

        -

        Default is false for clans, true for groups.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igrouppotentialmember.html b/docs/interfaces/igrouppotentialmember.html deleted file mode 100644 index 26095b1..0000000 --- a/docs/interfaces/igrouppotentialmember.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - IGroupPotentialMember | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupPotentialMember

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupPotentialMember -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        bungieNetUserInfo

        -
        bungieNetUserInfo: IUserInfoCard
        - -
        -
        - -

        destinyUserInfo

        -
        destinyUserInfo: IUserInfoCard
        - -
        -
        - -

        groupId

        -
        groupId: string
        - -
        -
        - -

        joinDate

        -
        joinDate: string
        - -
        -
        - -

        potentialStatus

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igrouppotentialmembership.html b/docs/interfaces/igrouppotentialmembership.html deleted file mode 100644 index 06f2f7f..0000000 --- a/docs/interfaces/igrouppotentialmembership.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IGroupPotentialMembership | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupPotentialMembership

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupPotentialMembership -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        group

        -
        group: IGroupV2
        - -
        -
        - -

        member

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igrouppotentialmembershipsearchresponse.html b/docs/interfaces/igrouppotentialmembershipsearchresponse.html deleted file mode 100644 index 8821e85..0000000 --- a/docs/interfaces/igrouppotentialmembershipsearchresponse.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - IGroupPotentialMembershipSearchResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupPotentialMembershipSearchResponse

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupPotentialMembershipSearchResponse -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        hasMore

        -
        hasMore: boolean
        - -
        -
        - -

        query

        - - -
        -
        - -

        replacementContinuationToken

        -
        replacementContinuationToken: string
        - -
        -
        - -

        results

        - - -
        -
        - -

        totalResults

        -
        totalResults: number
        - -
        -
        - -

        useTotalResults

        -
        useTotalResults: boolean
        - -
        -
        -

        If useTotalResults is true, then totalResults represents an accurate count.

        -
        -

        If False, it does not, and may be estimated/only the size of the current page.

        -

        Either way, you should probably always only trust hasMore.

        -

        This is a long-held historical throwback to when we used to do paging with known - total results. Those queries toasted our database, and we were left to hastily - alter our endpoints and create backward- compatible shims, of which - useTotalResults is one.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupquery.html b/docs/interfaces/igroupquery.html deleted file mode 100644 index 2ecc239..0000000 --- a/docs/interfaces/igroupquery.html +++ /dev/null @@ -1,336 +0,0 @@ - - - - - - IGroupQuery | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupQuery

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        NOTE: GroupQuery, as of Destiny 2, has essentially two totally different and - incompatible "modes".

        -
        -

        If you are querying for a group, you can pass any of the properties below.

        -

        If you are querying for a Clan, you MUST NOT pass any of the following - properties (they must be null or undefined in your request, not just empty - string/default values):

        -
          -
        • groupMemberCountFilter - localeFilter - tagText
        • -
        -

        If you pass these, you will get a useless InvalidParameters error.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupQuery -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        creationDate

        -
        creationDate: GroupDateRange
        - -
        -
        - -

        currentPage

        -
        currentPage: number
        - -
        -
        - -

        Optional groupMemberCountFilter

        -
        groupMemberCountFilter: number
        - -
        -
        - -

        groupType

        -
        groupType: GroupType
        - -
        -
        - -

        itemsPerPage

        -
        itemsPerPage: number
        - -
        -
        - -

        localeFilter

        -
        localeFilter: string
        - -
        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        requestContinuationToken

        -
        requestContinuationToken: string
        - -
        -
        - -

        sortBy

        -
        sortBy: GroupSortBy
        - -
        -
        - -

        tagText

        -
        tagText: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupresponse.html b/docs/interfaces/igroupresponse.html deleted file mode 100644 index a864391..0000000 --- a/docs/interfaces/igroupresponse.html +++ /dev/null @@ -1,322 +0,0 @@ - - - - - - IGroupResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupResponse

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupResponse -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        allianceStatus

        -
        allianceStatus: GroupAllianceStatus
        - -
        -
        - -

        alliedIds

        -
        alliedIds: string[]
        - -
        -
        - -

        currentUserMemberMap

        -
        currentUserMemberMap: object
        - -
        -
        -

        This property will be populated if the authenticated user is a member of the - group. Note that because of account linking, a user can sometimes be part of a - clan more than once. As such, this returns the highest member type available.

        -
        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        currentUserPotentialMemberMap

        -
        currentUserPotentialMemberMap: object
        - -
        -
        -

        This property will be populated if the authenticated user is an applicant or has - an outstanding invitation to join. Note that because of account linking, a user - can sometimes be part of a clan more than once.

        -
        -
        -
        -

        Type declaration

        - -
        -
        -
        - -

        detail

        -
        detail: IGroupV2
        - -
        -
        - -

        founder

        -
        founder: IGroupMember
        - -
        -
        - -

        groupJoinInviteCount

        -
        groupJoinInviteCount: number
        - -
        -
        - -

        parentGroup

        -
        parentGroup: IGroupV2
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupsearchresponse.html b/docs/interfaces/igroupsearchresponse.html deleted file mode 100644 index 37a19eb..0000000 --- a/docs/interfaces/igroupsearchresponse.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - IGroupSearchResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupSearchResponse

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupSearchResponse -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        hasMore

        -
        hasMore: boolean
        - -
        -
        - -

        query

        - - -
        -
        - -

        replacementContinuationToken

        -
        replacementContinuationToken: string
        - -
        -
        - -

        results

        -
        results: IGroupV2Card[]
        - -
        -
        - -

        totalResults

        -
        totalResults: number
        - -
        -
        - -

        useTotalResults

        -
        useTotalResults: boolean
        - -
        -
        -

        If useTotalResults is true, then totalResults represents an accurate count.

        -
        -

        If False, it does not, and may be estimated/only the size of the current page.

        -

        Either way, you should probably always only trust hasMore.

        -

        This is a long-held historical throwback to when we used to do paging with known - total results. Those queries toasted our database, and we were left to hastily - alter our endpoints and create backward- compatible shims, of which - useTotalResults is one.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igrouptheme.html b/docs/interfaces/igrouptheme.html deleted file mode 100644 index c540b89..0000000 --- a/docs/interfaces/igrouptheme.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IGroupTheme | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupTheme

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupTheme -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        description

        -
        description: string
        - -
        -
        - -

        folder

        -
        folder: string
        - -
        -
        - -

        name

        -
        name: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupv2.html b/docs/interfaces/igroupv2.html deleted file mode 100644 index bb4bcfc..0000000 --- a/docs/interfaces/igroupv2.html +++ /dev/null @@ -1,572 +0,0 @@ - - - - - - IGroupV2 | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupV2

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupV2 -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        about

        -
        about: string
        - -
        -
        - -

        allowChat

        -
        allowChat: boolean
        - -
        -
        - -

        avatarImageIndex

        -
        avatarImageIndex: number
        - -
        -
        - -

        avatarPath

        -
        avatarPath: string
        - -
        -
        - -

        Optional banExpireDate

        -
        banExpireDate: string
        - -
        -
        - -

        bannerPath

        -
        bannerPath: string
        - -
        -
        - -

        chatSecurity

        -
        chatSecurity: ChatSecuritySetting
        - -
        -
        - -

        clanInfo

        - - -
        -
        - -

        conversationId

        -
        conversationId: string
        - -
        -
        - -

        creationDate

        -
        creationDate: string
        - -
        -
        - -

        defaultPublicity

        -
        defaultPublicity: GroupPostPublicity
        - -
        -
        - -

        enableInvitationMessagingForAdmins

        -
        enableInvitationMessagingForAdmins: boolean
        - -
        -
        - -

        features

        -
        features: IGroupFeatures
        - -
        -
        - -

        groupId

        -
        groupId: string
        - -
        -
        - -

        groupType

        -
        groupType: GroupType
        - -
        -
        - -

        homepage

        -
        homepage: GroupHomepage
        - -
        -
        - -

        isDefaultPostPublic

        -
        isDefaultPostPublic: boolean
        - -
        -
        - -

        isPublic

        -
        isPublic: boolean
        - -
        -
        - -

        isPublicTopicAdminOnly

        -
        isPublicTopicAdminOnly: boolean
        - -
        -
        - -

        locale

        -
        locale: string
        - -
        -
        - -

        memberCount

        -
        memberCount: number
        - -
        -
        - -

        membershipIdCreated

        -
        membershipIdCreated: string
        - -
        -
        - -

        membershipOption

        -
        membershipOption: MembershipOption
        - -
        -
        - -

        modificationDate

        -
        modificationDate: string
        - -
        -
        - -

        motto

        -
        motto: string
        - -
        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        tags

        -
        tags: string[]
        - -
        -
        - -

        theme

        -
        theme: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupv2card.html b/docs/interfaces/igroupv2card.html deleted file mode 100644 index 53b0e07..0000000 --- a/docs/interfaces/igroupv2card.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - - IGroupV2Card | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupV2Card

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        A small infocard of group information, usually used for when a list of groups - are returned

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupV2Card -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        about

        -
        about: string
        - -
        -
        - -

        avatarPath

        -
        avatarPath: string
        - -
        -
        - -

        capabilities

        -
        capabilities: Capabilities
        - -
        -
        - -

        clanInfo

        - - -
        -
        - -

        creationDate

        -
        creationDate: string
        - -
        -
        - -

        groupId

        -
        groupId: string
        - -
        -
        - -

        groupType

        -
        groupType: GroupType
        - -
        -
        - -

        locale

        -
        locale: string
        - -
        -
        - -

        memberCount

        -
        memberCount: number
        - -
        -
        - -

        membershipOption

        -
        membershipOption: MembershipOption
        - -
        -
        - -

        motto

        -
        motto: string
        - -
        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        theme

        -
        theme: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupv2claninfo.html b/docs/interfaces/igroupv2claninfo.html deleted file mode 100644 index e5d60ec..0000000 --- a/docs/interfaces/igroupv2claninfo.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - - IGroupV2ClanInfo | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupV2ClanInfo

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This contract contains clan-specific group information. It does not include any - investment data.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupV2ClanInfo -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        clanBannerData

        -
        clanBannerData: IClanBanner
        - -
        -
        - -

        clanCallsign

        -
        clanCallsign: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/igroupv2claninfoandinvestment.html b/docs/interfaces/igroupv2claninfoandinvestment.html deleted file mode 100644 index d4e4eb5..0000000 --- a/docs/interfaces/igroupv2claninfoandinvestment.html +++ /dev/null @@ -1,237 +0,0 @@ - - - - - - IGroupV2ClanInfoAndInvestment | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IGroupV2ClanInfoAndInvestment

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The same as GroupV2ClanInfo, but includes any investment data.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IGroupV2ClanInfoAndInvestment -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        clanBannerData

        -
        clanBannerData: IClanBanner
        - -
        -
        - -

        clanCallsign

        -
        clanCallsign: string
        - -
        -
        - -

        d2ClanProgressions

        -
        d2ClanProgressions: object
        - -
        -

        Type declaration

        - -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/ihyperlinkreference.html b/docs/interfaces/ihyperlinkreference.html deleted file mode 100644 index 51d4ae5..0000000 --- a/docs/interfaces/ihyperlinkreference.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IHyperlinkReference | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IHyperlinkReference

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IHyperlinkReference -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        title

        -
        title: string
        - -
        -
        - -

        url

        -
        url: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iignoreresponse.html b/docs/interfaces/iignoreresponse.html deleted file mode 100644 index 4ae36d9..0000000 --- a/docs/interfaces/iignoreresponse.html +++ /dev/null @@ -1,221 +0,0 @@ - - - - - - IIgnoreResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IIgnoreResponse

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Bungie.Net API - These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.

        -
        -

        OpenAPI spec version: 2.3.3 - Contact: support@bungie.com

        -

        NOTE: This class is auto generated by the bungie-api-ts code generator program. - https://github.com/DestinyItemManager/bugie-api-ts - Do not edit these files manually.

        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IIgnoreResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        ignoreFlags

        -
        ignoreFlags: IgnoreStatus
        - -
        -
        - -

        isIgnored

        -
        isIgnored: boolean
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iinterpolationpoint.html b/docs/interfaces/iinterpolationpoint.html deleted file mode 100644 index 4e1d38a..0000000 --- a/docs/interfaces/iinterpolationpoint.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IInterpolationPoint | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IInterpolationPoint

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IInterpolationPoint -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        value

        -
        value: number
        - -
        -
        - -

        weight

        -
        weight: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iinterpolationpointfloat.html b/docs/interfaces/iinterpolationpointfloat.html deleted file mode 100644 index 5181ab3..0000000 --- a/docs/interfaces/iinterpolationpointfloat.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - IInterpolationPointFloat | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IInterpolationPointFloat

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IInterpolationPointFloat -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        value

        -
        value: number
        - -
        -
        - -

        weight

        -
        weight: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/imagepyramidentry.html b/docs/interfaces/imagepyramidentry.html new file mode 100644 index 0000000..862dfed --- /dev/null +++ b/docs/interfaces/imagepyramidentry.html @@ -0,0 +1,218 @@ + + + + + + ImagePyramidEntry | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface ImagePyramidEntry

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + ImagePyramidEntry +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        factor

        +
        factor: number
        + +
        +
        +

        The factor by which the original image size has been reduced.

        +
        +
        +
        +
        + +

        name

        +
        name: string
        + +
        +
        +

        The name of the subfolder where these images are located.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/interpolationpoint.html b/docs/interfaces/interpolationpoint.html new file mode 100644 index 0000000..65cfd37 --- /dev/null +++ b/docs/interfaces/interpolationpoint.html @@ -0,0 +1,208 @@ + + + + + + InterpolationPoint | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface InterpolationPoint

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + InterpolationPoint +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        value

        +
        value: number
        + +
        +
        + +

        weight

        +
        weight: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/interpolationpointfloat.html b/docs/interfaces/interpolationpointfloat.html new file mode 100644 index 0000000..5f6dc9c --- /dev/null +++ b/docs/interfaces/interpolationpointfloat.html @@ -0,0 +1,208 @@ + + + + + + InterpolationPointFloat | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface InterpolationPointFloat

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + InterpolationPointFloat +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        value

        +
        value: number
        + +
        +
        + +

        weight

        +
        weight: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/ioauthresponse.html b/docs/interfaces/ioauthresponse.html deleted file mode 100644 index 2e83c5d..0000000 --- a/docs/interfaces/ioauthresponse.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - IOAuthResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IOAuthResponse

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Interface for defining an object for the OAuth response

        -
        -
        -
        interface
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IOAuthResponse -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        access_token

        -
        access_token: string
        - -
        -
        - -

        expires_in

        -
        expires_in: number
        - -
        -
        - -

        membership_id

        -
        membership_id: string
        - -
        -
        - -

        Optional refresh_expires_in

        -
        refresh_expires_in: number
        - -
        -
        - -

        Optional refresh_token

        -
        refresh_token: string
        - -
        -
        - -

        token_type

        -
        token_type: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/ipagedquery.html b/docs/interfaces/ipagedquery.html deleted file mode 100644 index fe0778e..0000000 --- a/docs/interfaces/ipagedquery.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IPagedQuery | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IPagedQuery

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IPagedQuery -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        currentPage

        -
        currentPage: number
        - -
        -
        - -

        itemsPerPage

        -
        itemsPerPage: number
        - -
        -
        - -

        requestContinuationToken

        -
        requestContinuationToken: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/ipollresponse.html b/docs/interfaces/ipollresponse.html deleted file mode 100644 index 7c39c1d..0000000 --- a/docs/interfaces/ipollresponse.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IPollResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IPollResponse

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IPollResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        results

        -
        results: IPollResult[]
        - -
        -
        - -

        topicId

        -
        topicId: string
        - -
        -
        - -

        totalVotes

        -
        totalVotes: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/ipollresult.html b/docs/interfaces/ipollresult.html deleted file mode 100644 index 8cb879d..0000000 --- a/docs/interfaces/ipollresult.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - IPollResult | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IPollResult

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IPollResult -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        answerSlot

        -
        answerSlot: number
        - -
        -
        - -

        answerText

        -
        answerText: string
        - -
        -
        - -

        lastVoteDate

        -
        lastVoteDate: string
        - -
        -
        - -

        requestingUserVoted

        -
        requestingUserVoted: boolean
        - -
        -
        - -

        votes

        -
        votes: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/ipostresponse.html b/docs/interfaces/ipostresponse.html deleted file mode 100644 index dcf89d2..0000000 --- a/docs/interfaces/ipostresponse.html +++ /dev/null @@ -1,376 +0,0 @@ - - - - - - IPostResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IPostResponse

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IPostResponse -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        IsPinned

        -
        IsPinned: boolean
        - -
        -
        - -

        ignoreStatus

        -
        ignoreStatus: IIgnoreResponse
        - -
        -
        - -

        isActive

        -
        isActive: boolean
        - -
        -
        - -

        isAnnouncement

        -
        isAnnouncement: boolean
        - -
        -
        - -

        lastReplyTimestamp

        -
        lastReplyTimestamp: string
        - -
        -
        - -

        latestReplyAuthorId

        -
        latestReplyAuthorId: string
        - -
        -
        - -

        latestReplyPostId

        -
        latestReplyPostId: string
        - -
        -
        - -

        locale

        -
        locale: string
        - -
        -
        - -

        popularity

        - - -
        -
        - -

        thumbnail

        -
        thumbnail: string
        - -
        -
        - -

        urlMediaType

        -
        urlMediaType: ForumMediaType
        - -
        -
        - -

        userHasMutedPost

        -
        userHasMutedPost: boolean
        - -
        -
        - -

        userHasRated

        -
        userHasRated: boolean
        - -
        -
        - -

        userRating

        -
        userRating: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/ipostsearchresponse.html b/docs/interfaces/ipostsearchresponse.html deleted file mode 100644 index 08702f5..0000000 --- a/docs/interfaces/ipostsearchresponse.html +++ /dev/null @@ -1,373 +0,0 @@ - - - - - - IPostSearchResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IPostSearchResponse

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IPostSearchResponse -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        authors

        -
        authors: IGeneralUser[]
        - -
        -
        - -

        Optional availablePages

        -
        availablePages: number
        - -
        -
        - -

        groups

        -
        groups: IGroupResponse[]
        - -
        -
        - -

        hasMore

        -
        hasMore: boolean
        - -
        -
        - -

        polls

        -
        polls: IPollResponse[]
        - -
        -
        - -

        query

        - - -
        -
        - -

        recruitmentDetails

        -
        recruitmentDetails: IForumRecruitmentDetail[]
        - -
        -
        - -

        relatedPosts

        -
        relatedPosts: IPostResponse[]
        - -
        -
        - -

        replacementContinuationToken

        -
        replacementContinuationToken: string
        - -
        -
        - -

        results

        -
        results: IPostResponse[]
        - -
        -
        - -

        searchedTags

        -
        searchedTags: ITagResponse[]
        - -
        -
        - -

        totalResults

        -
        totalResults: number
        - -
        -
        - -

        useTotalResults

        -
        useTotalResults: boolean
        - -
        -
        -

        If useTotalResults is true, then totalResults represents an accurate count.

        -
        -

        If False, it does not, and may be estimated/only the size of the current page.

        -

        Either way, you should probably always only trust hasMore.

        -

        This is a long-held historical throwback to when we used to do paging with known - total results. Those queries toasted our database, and we were left to hastily - alter our endpoints and create backward- compatible shims, of which - useTotalResults is one.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/ipublicpartnershipdetail.html b/docs/interfaces/ipublicpartnershipdetail.html deleted file mode 100644 index ea0a97f..0000000 --- a/docs/interfaces/ipublicpartnershipdetail.html +++ /dev/null @@ -1,243 +0,0 @@ - - - - - - IPublicPartnershipDetail | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IPublicPartnershipDetail

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        All the partnership info that's fit to expose externally, if we care to do so.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IPublicPartnershipDetail -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        icon

        -
        icon: string
        - -
        -
        - -

        identifier

        -
        identifier: string
        - -
        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        partnerType

        -
        partnerType: PartnershipType
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iquerystringparameters.html b/docs/interfaces/iquerystringparameters.html deleted file mode 100644 index b0183dc..0000000 --- a/docs/interfaces/iquerystringparameters.html +++ /dev/null @@ -1,354 +0,0 @@ - - - - - - IQueryStringParameters | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IQueryStringParameters

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Interface for defining an object for the endpoint query strings

        -
        -
        -
        interface
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IQueryStringParameters -
        • -
        -
        -
        -

        Indexable

        -
        [key: string]: any
        -
        -
        -

        Interface for defining an object for the endpoint query strings

        -
        -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        Optional components

        -
        components: DestinyComponentType[]
        - -
        -
        - -

        Optional count

        -
        count: number
        - -
        -
        - -

        Optional dayend

        -
        dayend: string
        - -
        -
        - -

        Optional daystart

        -
        daystart: string
        - -
        -
        - -

        Optional groups

        - - -
        -
        - -

        Optional maxtop

        -
        maxtop: number
        - -
        -
        - -

        Optional mode

        - - -
        -
        - -

        Optional modes

        - - -
        -
        - -

        Optional page

        -
        page: number
        - -
        -
        - -

        Optional periodType

        -
        periodType: PeriodType
        - -
        -
        - -

        Optional statid

        -
        statid: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/isavemessageresult.html b/docs/interfaces/isavemessageresult.html deleted file mode 100644 index 2a663ef..0000000 --- a/docs/interfaces/isavemessageresult.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - ISaveMessageResult | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ISaveMessageResult

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ISaveMessageResult -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        conversationId

        -
        conversationId: string
        - -
        -
        - -

        messageId

        -
        messageId: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/ischemarecordstateblock.html b/docs/interfaces/ischemarecordstateblock.html deleted file mode 100644 index 8188806..0000000 --- a/docs/interfaces/ischemarecordstateblock.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - ISchemaRecordStateBlock | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ISchemaRecordStateBlock

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ISchemaRecordStateBlock -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        featuredPriority

        -
        featuredPriority: number
        - -
        -
        - -

        obscuredString

        -
        obscuredString: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/isearchresultofcommunitylivestatus.html b/docs/interfaces/isearchresultofcommunitylivestatus.html deleted file mode 100644 index 5055a47..0000000 --- a/docs/interfaces/isearchresultofcommunitylivestatus.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - ISearchResultOfCommunityLiveStatus | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ISearchResultOfCommunityLiveStatus

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ISearchResultOfCommunityLiveStatus -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        hasMore

        -
        hasMore: boolean
        - -
        -
        - -

        query

        - - -
        -
        - -

        replacementContinuationToken

        -
        replacementContinuationToken: string
        - -
        -
        - -

        results

        - - -
        -
        - -

        totalResults

        -
        totalResults: number
        - -
        -
        - -

        useTotalResults

        -
        useTotalResults: boolean
        - -
        -
        -

        If useTotalResults is true, then totalResults represents an accurate count.

        -
        -

        If False, it does not, and may be estimated/only the size of the current page.

        -

        Either way, you should probably always only trust hasMore.

        -

        This is a long-held historical throwback to when we used to do paging with known - total results. Those queries toasted our database, and we were left to hastily - alter our endpoints and create backward- compatible shims, of which - useTotalResults is one.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/isearchresultofcontentitempubliccontract.html b/docs/interfaces/isearchresultofcontentitempubliccontract.html deleted file mode 100644 index e341b37..0000000 --- a/docs/interfaces/isearchresultofcontentitempubliccontract.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - ISearchResultOfContentItemPublicContract | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ISearchResultOfContentItemPublicContract

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ISearchResultOfContentItemPublicContract -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        hasMore

        -
        hasMore: boolean
        - -
        -
        - -

        query

        - - -
        -
        - -

        replacementContinuationToken

        -
        replacementContinuationToken: string
        - -
        -
        - -

        results

        - - -
        -
        - -

        totalResults

        -
        totalResults: number
        - -
        -
        - -

        useTotalResults

        -
        useTotalResults: boolean
        - -
        -
        -

        If useTotalResults is true, then totalResults represents an accurate count.

        -
        -

        If False, it does not, and may be estimated/only the size of the current page.

        -

        Either way, you should probably always only trust hasMore.

        -

        This is a long-held historical throwback to when we used to do paging with known - total results. Those queries toasted our database, and we were left to hastily - alter our endpoints and create backward- compatible shims, of which - useTotalResults is one.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/isearchresultofdestinyentitysearchresultitem.html b/docs/interfaces/isearchresultofdestinyentitysearchresultitem.html deleted file mode 100644 index b754258..0000000 --- a/docs/interfaces/isearchresultofdestinyentitysearchresultitem.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - ISearchResultOfDestinyEntitySearchResultItem | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ISearchResultOfDestinyEntitySearchResultItem

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ISearchResultOfDestinyEntitySearchResultItem -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        hasMore

        -
        hasMore: boolean
        - -
        -
        - -

        query

        - - -
        -
        - -

        replacementContinuationToken

        -
        replacementContinuationToken: string
        - -
        -
        - -

        results

        - - -
        -
        - -

        totalResults

        -
        totalResults: number
        - -
        -
        - -

        useTotalResults

        -
        useTotalResults: boolean
        - -
        -
        -

        If useTotalResults is true, then totalResults represents an accurate count.

        -
        -

        If False, it does not, and may be estimated/only the size of the current page.

        -

        Either way, you should probably always only trust hasMore.

        -

        This is a long-held historical throwback to when we used to do paging with known - total results. Those queries toasted our database, and we were left to hastily - alter our endpoints and create backward- compatible shims, of which - useTotalResults is one.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/isearchresultoffireteamresponse.html b/docs/interfaces/isearchresultoffireteamresponse.html deleted file mode 100644 index e3980dc..0000000 --- a/docs/interfaces/isearchresultoffireteamresponse.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - ISearchResultOfFireteamResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ISearchResultOfFireteamResponse

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ISearchResultOfFireteamResponse -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        hasMore

        -
        hasMore: boolean
        - -
        -
        - -

        query

        - - -
        -
        - -

        replacementContinuationToken

        -
        replacementContinuationToken: string
        - -
        -
        - -

        results

        - - -
        -
        - -

        totalResults

        -
        totalResults: number
        - -
        -
        - -

        useTotalResults

        -
        useTotalResults: boolean
        - -
        -
        -

        If useTotalResults is true, then totalResults represents an accurate count.

        -
        -

        If False, it does not, and may be estimated/only the size of the current page.

        -

        Either way, you should probably always only trust hasMore.

        -

        This is a long-held historical throwback to when we used to do paging with known - total results. Those queries toasted our database, and we were left to hastily - alter our endpoints and create backward- compatible shims, of which - useTotalResults is one.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/isearchresultoffireteamsummary.html b/docs/interfaces/isearchresultoffireteamsummary.html deleted file mode 100644 index 26e26fa..0000000 --- a/docs/interfaces/isearchresultoffireteamsummary.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - ISearchResultOfFireteamSummary | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ISearchResultOfFireteamSummary

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ISearchResultOfFireteamSummary -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        hasMore

        -
        hasMore: boolean
        - -
        -
        - -

        query

        - - -
        -
        - -

        replacementContinuationToken

        -
        replacementContinuationToken: string
        - -
        -
        - -

        results

        -
        results: IFireteamSummary[]
        - -
        -
        - -

        totalResults

        -
        totalResults: number
        - -
        -
        - -

        useTotalResults

        -
        useTotalResults: boolean
        - -
        -
        -

        If useTotalResults is true, then totalResults represents an accurate count.

        -
        -

        If False, it does not, and may be estimated/only the size of the current page.

        -

        Either way, you should probably always only trust hasMore.

        -

        This is a long-held historical throwback to when we used to do paging with known - total results. Those queries toasted our database, and we were left to hastily - alter our endpoints and create backward- compatible shims, of which - useTotalResults is one.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/isearchresultofgroupban.html b/docs/interfaces/isearchresultofgroupban.html deleted file mode 100644 index cd4f8bd..0000000 --- a/docs/interfaces/isearchresultofgroupban.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - ISearchResultOfGroupBan | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ISearchResultOfGroupBan

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ISearchResultOfGroupBan -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        hasMore

        -
        hasMore: boolean
        - -
        -
        - -

        query

        - - -
        -
        - -

        replacementContinuationToken

        -
        replacementContinuationToken: string
        - -
        -
        - -

        results

        -
        results: IGroupBan[]
        - -
        -
        - -

        totalResults

        -
        totalResults: number
        - -
        -
        - -

        useTotalResults

        -
        useTotalResults: boolean
        - -
        -
        -

        If useTotalResults is true, then totalResults represents an accurate count.

        -
        -

        If False, it does not, and may be estimated/only the size of the current page.

        -

        Either way, you should probably always only trust hasMore.

        -

        This is a long-held historical throwback to when we used to do paging with known - total results. Those queries toasted our database, and we were left to hastily - alter our endpoints and create backward- compatible shims, of which - useTotalResults is one.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/isearchresultofgroupmember.html b/docs/interfaces/isearchresultofgroupmember.html deleted file mode 100644 index e4bdbfd..0000000 --- a/docs/interfaces/isearchresultofgroupmember.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - ISearchResultOfGroupMember | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ISearchResultOfGroupMember

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ISearchResultOfGroupMember -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        hasMore

        -
        hasMore: boolean
        - -
        -
        - -

        query

        - - -
        -
        - -

        replacementContinuationToken

        -
        replacementContinuationToken: string
        - -
        -
        - -

        results

        -
        results: IGroupMember[]
        - -
        -
        - -

        totalResults

        -
        totalResults: number
        - -
        -
        - -

        useTotalResults

        -
        useTotalResults: boolean
        - -
        -
        -

        If useTotalResults is true, then totalResults represents an accurate count.

        -
        -

        If False, it does not, and may be estimated/only the size of the current page.

        -

        Either way, you should probably always only trust hasMore.

        -

        This is a long-held historical throwback to when we used to do paging with known - total results. Those queries toasted our database, and we were left to hastily - alter our endpoints and create backward- compatible shims, of which - useTotalResults is one.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/isearchresultofgroupmemberapplication.html b/docs/interfaces/isearchresultofgroupmemberapplication.html deleted file mode 100644 index 32f4250..0000000 --- a/docs/interfaces/isearchresultofgroupmemberapplication.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - ISearchResultOfGroupMemberApplication | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ISearchResultOfGroupMemberApplication

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ISearchResultOfGroupMemberApplication -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        hasMore

        -
        hasMore: boolean
        - -
        -
        - -

        query

        - - -
        -
        - -

        replacementContinuationToken

        -
        replacementContinuationToken: string
        - -
        -
        - -

        results

        - - -
        -
        - -

        totalResults

        -
        totalResults: number
        - -
        -
        - -

        useTotalResults

        -
        useTotalResults: boolean
        - -
        -
        -

        If useTotalResults is true, then totalResults represents an accurate count.

        -
        -

        If False, it does not, and may be estimated/only the size of the current page.

        -

        Either way, you should probably always only trust hasMore.

        -

        This is a long-held historical throwback to when we used to do paging with known - total results. Those queries toasted our database, and we were left to hastily - alter our endpoints and create backward- compatible shims, of which - useTotalResults is one.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/isearchresultoftrendingentry.html b/docs/interfaces/isearchresultoftrendingentry.html deleted file mode 100644 index 75253f4..0000000 --- a/docs/interfaces/isearchresultoftrendingentry.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - ISearchResultOfTrendingEntry | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ISearchResultOfTrendingEntry

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ISearchResultOfTrendingEntry -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        hasMore

        -
        hasMore: boolean
        - -
        -
        - -

        query

        - - -
        -
        - -

        replacementContinuationToken

        -
        replacementContinuationToken: string
        - -
        -
        - -

        results

        -
        results: ITrendingEntry[]
        - -
        -
        - -

        totalResults

        -
        totalResults: number
        - -
        -
        - -

        useTotalResults

        -
        useTotalResults: boolean
        - -
        -
        -

        If useTotalResults is true, then totalResults represents an accurate count.

        -
        -

        If False, it does not, and may be estimated/only the size of the current page.

        -

        Either way, you should probably always only trust hasMore.

        -

        This is a long-held historical throwback to when we used to do paging with known - total results. Those queries toasted our database, and we were left to hastily - alter our endpoints and create backward- compatible shims, of which - useTotalResults is one.

        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iseries.html b/docs/interfaces/iseries.html deleted file mode 100644 index 4c48107..0000000 --- a/docs/interfaces/iseries.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - - ISeries | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ISeries

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ISeries -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        datapoints

        -
        datapoints: IDatapoint[]
        - -
        -
        -

        Collection of samples with time and value.

        -
        -
        -
        -
        - -

        target

        -
        target: string
        - -
        -
        -

        Target to which to datapoints apply.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iserverresponse.html b/docs/interfaces/iserverresponse.html deleted file mode 100644 index 74ae966..0000000 --- a/docs/interfaces/iserverresponse.html +++ /dev/null @@ -1,293 +0,0 @@ - - - - - - IServerResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IServerResponse<T>

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Bungie.Net API - These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.

        -
        -

        OpenAPI spec version: 2.3.3 - Contact: support@bungie.com

        -

        NOTE: This class is auto generated by the bungie-api-ts code generator program. - https://github.com/DestinyItemManager/bugie-api-ts - Do not edit these files manually.

        -
        -
        -
        -

        Type parameters

        -
          -
        • -

          T

          -
        • -
        -
        -
        -

        Hierarchy

        -
          -
        • - IServerResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        ErrorCode

        - - -
        -
        - -

        ErrorStatus

        -
        ErrorStatus: string
        - -
        -
        - -

        Message

        -
        Message: string
        - -
        -
        - -

        MessageData

        -
        MessageData: object
        - -
        -

        Type declaration

        -
          -
        • -
          [key: string]: string
          -
        • -
        -
        -
        -
        - -

        Response

        -
        Response: T
        - -
        -
        - -

        ThrottleSeconds

        -
        ThrottleSeconds: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/isinglecomponentresponse.html b/docs/interfaces/isinglecomponentresponse.html deleted file mode 100644 index 5ea0889..0000000 --- a/docs/interfaces/isinglecomponentresponse.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - - ISingleComponentResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ISingleComponentResponse<T>

        -
        -
        -
        -
        -
        -
        -
        -

        Type parameters

        -
          -
        • -

          T

          -
        • -
        -
        -
        -

        Hierarchy

        -
          -
        • - ISingleComponentResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        data

        -
        data: T
        - -
        -
        - -

        privacy

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/istreaminfo.html b/docs/interfaces/istreaminfo.html deleted file mode 100644 index 7d234aa..0000000 --- a/docs/interfaces/istreaminfo.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - IStreamInfo | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IStreamInfo

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IStreamInfo -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        ChannelName

        -
        ChannelName: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/itagmetadatadefinition.html b/docs/interfaces/itagmetadatadefinition.html deleted file mode 100644 index b80ac5a..0000000 --- a/docs/interfaces/itagmetadatadefinition.html +++ /dev/null @@ -1,264 +0,0 @@ - - - - - - ITagMetadataDefinition | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ITagMetadataDefinition

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ITagMetadataDefinition -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        datatype

        -
        datatype: string
        - -
        -
        - -

        description

        -
        description: string
        - -
        -
        - -

        isRequired

        -
        isRequired: boolean
        - -
        -
        - -

        items

        - - -
        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        order

        -
        order: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/itagmetadataitem.html b/docs/interfaces/itagmetadataitem.html deleted file mode 100644 index b06fcab..0000000 --- a/docs/interfaces/itagmetadataitem.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - ITagMetadataItem | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ITagMetadataItem

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ITagMetadataItem -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        description

        -
        description: string
        - -
        -
        - -

        groups

        -
        groups: string[]
        - -
        -
        - -

        isDefault

        -
        isDefault: boolean
        - -
        -
        - -

        name

        -
        name: string
        - -
        -
        - -

        tagText

        -
        tagText: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/itagresponse.html b/docs/interfaces/itagresponse.html deleted file mode 100644 index b26c0dd..0000000 --- a/docs/interfaces/itagresponse.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - ITagResponse | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ITagResponse

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ITagResponse -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        ignoreStatus

        -
        ignoreStatus: IIgnoreResponse
        - -
        -
        - -

        tagText

        -
        tagText: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/itravelerconfig.html b/docs/interfaces/itravelerconfig.html deleted file mode 100644 index e0cc97c..0000000 --- a/docs/interfaces/itravelerconfig.html +++ /dev/null @@ -1,261 +0,0 @@ - - - - - - ITravelerConfig | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ITravelerConfig

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Interface for defining an object for the Traveler class

        -
        -
        -
        interface
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ITravelerConfig -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        apikey

        -
        apikey: string
        - -
        -
        - -

        Optional debug

        -
        debug: boolean
        - -
        -
        - -

        Optional oauthClientId

        -
        oauthClientId: string
        - -
        -
        - -

        Optional oauthClientSecret

        -
        oauthClientSecret: string
        - -
        -
        - -

        userAgent

        -
        userAgent: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/itrendingcategories.html b/docs/interfaces/itrendingcategories.html deleted file mode 100644 index 12f07b2..0000000 --- a/docs/interfaces/itrendingcategories.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - ITrendingCategories | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ITrendingCategories

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ITrendingCategories -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        categories

        -
        categories: ITrendingCategory[]
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/itrendingcategory.html b/docs/interfaces/itrendingcategory.html deleted file mode 100644 index 54b9740..0000000 --- a/docs/interfaces/itrendingcategory.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - ITrendingCategory | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ITrendingCategory

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ITrendingCategory -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        categoryId

        -
        categoryId: string
        - -
        -
        - -

        categoryName

        -
        categoryName: string
        - -
        -
        - -

        entries

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/itrendingdetail.html b/docs/interfaces/itrendingdetail.html deleted file mode 100644 index c571eed..0000000 --- a/docs/interfaces/itrendingdetail.html +++ /dev/null @@ -1,306 +0,0 @@ - - - - - - ITrendingDetail | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ITrendingDetail

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ITrendingDetail -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        creation

        - - -
        -
        - -

        destinyActivity

        - - -
        -
        - -

        destinyItem

        - - -
        -
        - -

        destinyRitual

        - - -
        -
        - -

        entityType

        -
        entityType: TrendingEntryType
        - -
        -
        - -

        identifier

        -
        identifier: string
        - -
        -
        - -

        news

        - - -
        -
        - -

        stream

        - - -
        -
        - -

        support

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/itrendingentry.html b/docs/interfaces/itrendingentry.html deleted file mode 100644 index c5850ed..0000000 --- a/docs/interfaces/itrendingentry.html +++ /dev/null @@ -1,461 +0,0 @@ - - - - - - ITrendingEntry | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ITrendingEntry

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        The list entry view for trending items. Returns just enough to show the item on - the trending page.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ITrendingEntry -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        Optional creationDate

        -
        creationDate: string
        - -
        -
        -

        If the entry has a date at which it was created, this is that date.

        -
        -
        -
        -
        - -

        displayName

        -
        displayName: string
        - -
        -
        -

        The localized "display name/article title/'primary localized identifier'" of the - entity.

        -
        -
        -
        -
        - -

        Optional endDate

        -
        endDate: string
        - -
        -
        - -

        entityType

        -
        entityType: TrendingEntryType
        - -
        -
        -

        An enum - unfortunately - dictating all of the possible kinds of trending items - that you might get in your result set, in case you want to do custom rendering - or call to get the details of the item.

        -
        -
        -
        -
        - -

        featureImage

        -
        featureImage: string
        - -
        -
        -

        If isFeatured, this image will be populated with whatever the featured image is. - Note that this will likely be a very large image, so don't use it all the time.

        -
        -
        -
        -
        - -

        identifier

        -
        identifier: string
        - -
        -
        -

        We don't know whether the identifier will be a string, a uint, or a long... so - we're going to cast it all to a string. But either way, we need any trending - item created to have a single unique identifier for its type.

        -
        -
        -
        -
        - -

        image

        -
        image: string
        - -
        -
        - -

        isFeatured

        -
        isFeatured: boolean
        - -
        -
        - -

        items

        - - -
        -
        -

        If the item is of entityType TrendingEntryType.Container, it may have items - - also Trending Entries - contained within it. This is the ordered list of those - to display under the Container's header.

        -
        -
        -
        -
        - -

        link

        -
        link: string
        - -
        -
        - -

        mp4Video

        -
        mp4Video: string
        - -
        -
        -

        If this is populated, the entry has a related MP4 video to show. I am 100% - certain I am going to regret putting this directly on TrendingEntry, but it will - work so yolo

        -
        -
        -
        -
        - -

        Optional startDate

        -
        startDate: string
        - -
        -
        - -

        tagline

        -
        tagline: string
        - -
        -
        -

        If the entity has a localized tagline/subtitle/motto/whatever, that is found - here.

        -
        -
        -
        -
        - -

        webmVideo

        -
        webmVideo: string
        - -
        -
        -

        If this is populated, the entry has a related WebM video to show. I am 100% - certain I am going to regret putting this directly on TrendingEntry, but it will - work so yolo

        -
        -
        -
        -
        - -

        weight

        -
        weight: number
        - -
        -
        -

        The weighted score of this trending item.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/itrendingentrycommunitycreation.html b/docs/interfaces/itrendingentrycommunitycreation.html deleted file mode 100644 index 0f3e2fa..0000000 --- a/docs/interfaces/itrendingentrycommunitycreation.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - ITrendingEntryCommunityCreation | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ITrendingEntryCommunityCreation

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ITrendingEntryCommunityCreation -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        author

        -
        author: string
        - -
        -
        - -

        authorMembershipId

        -
        authorMembershipId: string
        - -
        -
        - -

        body

        -
        body: string
        - -
        -
        - -

        media

        -
        media: string
        - -
        -
        - -

        postId

        -
        postId: string
        - -
        -
        - -

        title

        -
        title: string
        - -
        -
        - -

        upvotes

        -
        upvotes: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/itrendingentrycommunitystream.html b/docs/interfaces/itrendingentrycommunitystream.html deleted file mode 100644 index 0a85dac..0000000 --- a/docs/interfaces/itrendingentrycommunitystream.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - ITrendingEntryCommunityStream | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ITrendingEntryCommunityStream

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ITrendingEntryCommunityStream -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        image

        -
        image: string
        - -
        -
        - -

        partnershipIdentifier

        -
        partnershipIdentifier: string
        - -
        -
        - -

        partnershipType

        -
        partnershipType: PartnershipType
        - -
        -
        - -

        title

        -
        title: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/itrendingentrydestinyactivity.html b/docs/interfaces/itrendingentrydestinyactivity.html deleted file mode 100644 index c251c99..0000000 --- a/docs/interfaces/itrendingentrydestinyactivity.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - ITrendingEntryDestinyActivity | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ITrendingEntryDestinyActivity

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ITrendingEntryDestinyActivity -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        activityHash

        -
        activityHash: number
        - -
        -
        - -

        status

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/itrendingentrydestinyitem.html b/docs/interfaces/itrendingentrydestinyitem.html deleted file mode 100644 index 8d9d431..0000000 --- a/docs/interfaces/itrendingentrydestinyitem.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - ITrendingEntryDestinyItem | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ITrendingEntryDestinyItem

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ITrendingEntryDestinyItem -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        itemHash

        -
        itemHash: number
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/itrendingentrydestinyritual.html b/docs/interfaces/itrendingentrydestinyritual.html deleted file mode 100644 index 4a572a0..0000000 --- a/docs/interfaces/itrendingentrydestinyritual.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - ITrendingEntryDestinyRitual | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ITrendingEntryDestinyRitual

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ITrendingEntryDestinyRitual -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        Optional dateEnd

        -
        dateEnd: string
        - -
        -
        - -

        Optional dateStart

        -
        dateStart: string
        - -
        -
        - -

        eventContent

        - - -
        -
        -

        A destiny event will not necessarily have milestone "custom content", but if it - does the details will be here.

        -
        -
        -
        -
        - -

        icon

        -
        icon: string
        - -
        -
        - -

        image

        -
        image: string
        - -
        -
        - -

        milestoneDetails

        -
        milestoneDetails: IDestinyPublicMilestone
        - -
        -
        -

        A destiny event does not necessarily have a related Milestone, but if it does - the details will be returned here.

        -
        -
        -
        -
        - -

        subtitle

        -
        subtitle: string
        - -
        -
        - -

        title

        -
        title: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/itrendingentrynews.html b/docs/interfaces/itrendingentrynews.html deleted file mode 100644 index 89fe603..0000000 --- a/docs/interfaces/itrendingentrynews.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - ITrendingEntryNews | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ITrendingEntryNews

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ITrendingEntryNews -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        article

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/itrendingentrysupportarticle.html b/docs/interfaces/itrendingentrysupportarticle.html deleted file mode 100644 index 0453c2b..0000000 --- a/docs/interfaces/itrendingentrysupportarticle.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - ITrendingEntrySupportArticle | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface ITrendingEntrySupportArticle

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - ITrendingEntrySupportArticle -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        article

        - - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iuserinfocard.html b/docs/interfaces/iuserinfocard.html deleted file mode 100644 index 6034872..0000000 --- a/docs/interfaces/iuserinfocard.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - IUserInfoCard | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IUserInfoCard

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        This contract supplies basic information commonly used to display a minimal - amount of information about a user. Take care to not add more properties here - unless the property applies in all (or at least the majority) of the situations - where UserInfoCard is used. Avoid adding game specific or platform specific - details here. In cases where UserInfoCard is a subset of the data needed in a - contract, use UserInfoCard as a property of other contracts.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IUserInfoCard -
        • -
        -
        -
        -

        Index

        -
        - -
        -
        -
        -

        Properties

        -
        - -

        displayName

        -
        displayName: string
        - -
        -
        -

        Display Name the player has chosen for themselves. The display name is optional - when the data type is used as input to a platform API.

        -
        -
        -
        -
        - -

        iconPath

        -
        iconPath: string
        - -
        -
        -

        URL the Icon if available.

        -
        -
        -
        -
        - -

        membershipId

        -
        membershipId: string
        - -
        -
        -

        Membership ID as they user is known in the Accounts service

        -
        -
        -
        -
        - -

        membershipType

        -
        membershipType: BungieMembershipType
        - -
        -
        -

        Type of the membership.

        -
        -
        -
        -
        - -

        supplementalDisplayName

        -
        supplementalDisplayName: string
        - -
        -
        -

        A platform specific additional display name - ex: psn Real Name, bnet Unique - Name, etc.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iusermembership.html b/docs/interfaces/iusermembership.html deleted file mode 100644 index 826718f..0000000 --- a/docs/interfaces/iusermembership.html +++ /dev/null @@ -1,245 +0,0 @@ - - - - - - IUserMembership | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IUserMembership

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Very basic info about a user as returned by the Account server.

        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IUserMembership -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        displayName

        -
        displayName: string
        - -
        -
        -

        Display Name the player has chosen for themselves. The display name is optional - when the data type is used as input to a platform API.

        -
        -
        -
        -
        - -

        membershipId

        -
        membershipId: string
        - -
        -
        -

        Membership ID as they user is known in the Accounts service

        -
        -
        -
        -
        - -

        membershipType

        -
        membershipType: BungieMembershipType
        - -
        -
        -

        Type of the membership.

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iusermembershipdata.html b/docs/interfaces/iusermembershipdata.html deleted file mode 100644 index ecd163d..0000000 --- a/docs/interfaces/iusermembershipdata.html +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - IUserMembershipData | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IUserMembershipData

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IUserMembershipData -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        bungieNetUser

        -
        bungieNetUser: IGeneralUser
        - -
        -
        - -

        destinyMemberships

        -
        destinyMemberships: IUserInfoCard[]
        - -
        -
        -

        this allows you to see destiny memberships that are visible and linked to this - account (regardless of whether or not they have characters on the world server)

        -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iusertheme.html b/docs/interfaces/iusertheme.html deleted file mode 100644 index 7294554..0000000 --- a/docs/interfaces/iusertheme.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IUserTheme | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IUserTheme

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IUserTheme -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        userThemeDescription

        -
        userThemeDescription: string
        - -
        -
        - -

        userThemeId

        -
        userThemeId: number
        - -
        -
        - -

        userThemeName

        -
        userThemeName: string
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/iusertousercontext.html b/docs/interfaces/iusertousercontext.html deleted file mode 100644 index 99d018b..0000000 --- a/docs/interfaces/iusertousercontext.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - IUserToUserContext | The Traveler - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
        • -
        • Public/Protected
        • -
        • All
        • -
        -
        - - - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface IUserToUserContext

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - IUserToUserContext -
        • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        Optional globalIgnoreEndDate

        -
        globalIgnoreEndDate: string
        - -
        -
        - -

        ignoreStatus

        -
        ignoreStatus: IIgnoreResponse
        - -
        -
        - -

        isFollowing

        -
        isFollowing: boolean
        - -
        -
        -
        - -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
        • -
        • Object literal
        • -
        • Variable
        • -
        • Function
        • -
        • Function with type parameter
        • -
        • Index signature
        • -
        • Type alias
        • -
        -
          -
        • Enumeration
        • -
        • Enumeration member
        • -
        • Property
        • -
        • Method
        • -
        -
          -
        • Interface
        • -
        • Interface with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Index signature
        • -
        -
          -
        • Class
        • -
        • Class with type parameter
        • -
        • Constructor
        • -
        • Property
        • -
        • Method
        • -
        • Accessor
        • -
        • Index signature
        • -
        -
          -
        • Inherited constructor
        • -
        • Inherited property
        • -
        • Inherited method
        • -
        • Inherited accessor
        • -
        -
          -
        • Protected property
        • -
        • Protected method
        • -
        • Protected accessor
        • -
        -
          -
        • Private property
        • -
        • Private method
        • -
        • Private accessor
        • -
        -
          -
        • Static property
        • -
        • Static method
        • -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/interfaces/oauthresponse.html b/docs/interfaces/oauthresponse.html new file mode 100644 index 0000000..b901f14 --- /dev/null +++ b/docs/interfaces/oauthresponse.html @@ -0,0 +1,275 @@ + + + + + + OAuthResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface OAuthResponse

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Interface for defining an object for the OAuth response

        +
        +
        +
        interface
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + OAuthResponse +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        access_token

        +
        access_token: string
        + +
        +
        + +

        expires_in

        +
        expires_in: number
        + +
        +
        + +

        membership_id

        +
        membership_id: string
        + +
        +
        + +

        Optional refresh_expires_in

        +
        refresh_expires_in: number
        + +
        +
        + +

        Optional refresh_token

        +
        refresh_token: string
        + +
        +
        + +

        token_type

        +
        token_type: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/pagedquery.html b/docs/interfaces/pagedquery.html new file mode 100644 index 0000000..fae2dfd --- /dev/null +++ b/docs/interfaces/pagedquery.html @@ -0,0 +1,222 @@ + + + + + + PagedQuery | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface PagedQuery

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + PagedQuery +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        currentPage

        +
        currentPage: number
        + +
        +
        + +

        itemsPerPage

        +
        itemsPerPage: number
        + +
        +
        + +

        requestContinuationToken

        +
        requestContinuationToken: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/personaldestinyvendorsaleitemsetcomponent.html b/docs/interfaces/personaldestinyvendorsaleitemsetcomponent.html new file mode 100644 index 0000000..1b031c6 --- /dev/null +++ b/docs/interfaces/personaldestinyvendorsaleitemsetcomponent.html @@ -0,0 +1,202 @@ + + + + + + PersonalDestinyVendorSaleItemSetComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface PersonalDestinyVendorSaleItemSetComponent

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + PersonalDestinyVendorSaleItemSetComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        saleItems

        +
        saleItems: object
        + +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/pollresponse.html b/docs/interfaces/pollresponse.html new file mode 100644 index 0000000..e1201db --- /dev/null +++ b/docs/interfaces/pollresponse.html @@ -0,0 +1,222 @@ + + + + + + PollResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface PollResponse

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + PollResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        results

        +
        results: PollResult[]
        + +
        +
        + +

        topicId

        +
        topicId: string
        + +
        +
        + +

        totalVotes

        +
        totalVotes: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/pollresult.html b/docs/interfaces/pollresult.html new file mode 100644 index 0000000..0627f06 --- /dev/null +++ b/docs/interfaces/pollresult.html @@ -0,0 +1,250 @@ + + + + + + PollResult | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface PollResult

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + PollResult +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        answerSlot

        +
        answerSlot: number
        + +
        +
        + +

        answerText

        +
        answerText: string
        + +
        +
        + +

        lastVoteDate

        +
        lastVoteDate: string
        + +
        +
        + +

        requestingUserVoted

        +
        requestingUserVoted: boolean
        + +
        +
        + +

        votes

        +
        votes: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/postresponse.html b/docs/interfaces/postresponse.html new file mode 100644 index 0000000..0d7288f --- /dev/null +++ b/docs/interfaces/postresponse.html @@ -0,0 +1,376 @@ + + + + + + PostResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface PostResponse

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + PostResponse +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        IsPinned

        +
        IsPinned: boolean
        + +
        +
        + +

        ignoreStatus

        +
        ignoreStatus: IgnoreResponse
        + +
        +
        + +

        isActive

        +
        isActive: boolean
        + +
        +
        + +

        isAnnouncement

        +
        isAnnouncement: boolean
        + +
        +
        + +

        lastReplyTimestamp

        +
        lastReplyTimestamp: string
        + +
        +
        + +

        latestReplyAuthorId

        +
        latestReplyAuthorId: string
        + +
        +
        + +

        latestReplyPostId

        +
        latestReplyPostId: string
        + +
        +
        + +

        locale

        +
        locale: string
        + +
        +
        + +

        popularity

        + + +
        +
        + +

        thumbnail

        +
        thumbnail: string
        + +
        +
        + +

        urlMediaType

        +
        urlMediaType: ForumMediaType
        + +
        +
        + +

        userHasMutedPost

        +
        userHasMutedPost: boolean
        + +
        +
        + +

        userHasRated

        +
        userHasRated: boolean
        + +
        +
        + +

        userRating

        +
        userRating: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/postsearchresponse.html b/docs/interfaces/postsearchresponse.html new file mode 100644 index 0000000..871c602 --- /dev/null +++ b/docs/interfaces/postsearchresponse.html @@ -0,0 +1,373 @@ + + + + + + PostSearchResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface PostSearchResponse

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + PostSearchResponse +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        authors

        +
        authors: GeneralUser[]
        + +
        +
        + +

        Optional availablePages

        +
        availablePages: number
        + +
        +
        + +

        groups

        +
        groups: GroupResponse[]
        + +
        +
        + +

        hasMore

        +
        hasMore: boolean
        + +
        +
        + +

        polls

        +
        polls: PollResponse[]
        + +
        +
        + +

        query

        +
        query: PagedQuery
        + +
        +
        + +

        recruitmentDetails

        +
        recruitmentDetails: ForumRecruitmentDetail[]
        + +
        +
        + +

        relatedPosts

        +
        relatedPosts: PostResponse[]
        + +
        +
        + +

        replacementContinuationToken

        +
        replacementContinuationToken: string
        + +
        +
        + +

        results

        +
        results: PostResponse[]
        + +
        +
        + +

        searchedTags

        +
        searchedTags: TagResponse[]
        + +
        +
        + +

        totalResults

        +
        totalResults: number
        + +
        +
        + +

        useTotalResults

        +
        useTotalResults: boolean
        + +
        +
        +

        If useTotalResults is true, then totalResults represents an accurate count.

        +
        +

        If False, it does not, and may be estimated/only the size of the current page.

        +

        Either way, you should probably always only trust hasMore.

        +

        This is a long-held historical throwback to when we used to do paging with known + total results. Those queries toasted our database, and we were left to hastily + alter our endpoints and create backward- compatible shims, of which + useTotalResults is one.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/publicdestinyvendorsaleitemsetcomponent.html b/docs/interfaces/publicdestinyvendorsaleitemsetcomponent.html new file mode 100644 index 0000000..5da4c49 --- /dev/null +++ b/docs/interfaces/publicdestinyvendorsaleitemsetcomponent.html @@ -0,0 +1,202 @@ + + + + + + PublicDestinyVendorSaleItemSetComponent | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface PublicDestinyVendorSaleItemSetComponent

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + PublicDestinyVendorSaleItemSetComponent +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        saleItems

        +
        saleItems: object
        + +
        +

        Type declaration

        + +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/publicpartnershipdetail.html b/docs/interfaces/publicpartnershipdetail.html new file mode 100644 index 0000000..78f3c1f --- /dev/null +++ b/docs/interfaces/publicpartnershipdetail.html @@ -0,0 +1,243 @@ + + + + + + PublicPartnershipDetail | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface PublicPartnershipDetail

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        All the partnership info that's fit to expose externally, if we care to do so.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + PublicPartnershipDetail +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        icon

        +
        icon: string
        + +
        +
        + +

        identifier

        +
        identifier: string
        + +
        +
        + +

        name

        +
        name: string
        + +
        +
        + +

        partnerType

        +
        partnerType: PartnershipType
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/querystringparameters.html b/docs/interfaces/querystringparameters.html new file mode 100644 index 0000000..f650bd1 --- /dev/null +++ b/docs/interfaces/querystringparameters.html @@ -0,0 +1,354 @@ + + + + + + QueryStringParameters | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface QueryStringParameters

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Interface for defining an object for the endpoint query strings

        +
        +
        +
        interface
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + QueryStringParameters +
        • +
        +
        +
        +

        Indexable

        +
        [key: string]: any
        +
        +
        +

        Interface for defining an object for the endpoint query strings

        +
        +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        Optional components

        +
        components: DestinyComponentType[]
        + +
        +
        + +

        Optional count

        +
        count: number
        + +
        +
        + +

        Optional dayend

        +
        dayend: string
        + +
        +
        + +

        Optional daystart

        +
        daystart: string
        + +
        +
        + +

        Optional groups

        + + +
        +
        + +

        Optional maxtop

        +
        maxtop: number
        + +
        +
        + +

        Optional mode

        + + +
        +
        + +

        Optional modes

        + + +
        +
        + +

        Optional page

        +
        page: number
        + +
        +
        + +

        Optional periodType

        +
        periodType: PeriodType
        + +
        +
        + +

        Optional statid

        +
        statid: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/schemarecordstateblock.html b/docs/interfaces/schemarecordstateblock.html new file mode 100644 index 0000000..655859d --- /dev/null +++ b/docs/interfaces/schemarecordstateblock.html @@ -0,0 +1,208 @@ + + + + + + SchemaRecordStateBlock | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface SchemaRecordStateBlock

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + SchemaRecordStateBlock +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        featuredPriority

        +
        featuredPriority: number
        + +
        +
        + +

        obscuredString

        +
        obscuredString: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/searchresultofcommunitylivestatus.html b/docs/interfaces/searchresultofcommunitylivestatus.html new file mode 100644 index 0000000..7b95645 --- /dev/null +++ b/docs/interfaces/searchresultofcommunitylivestatus.html @@ -0,0 +1,275 @@ + + + + + + SearchResultOfCommunityLiveStatus | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface SearchResultOfCommunityLiveStatus

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + SearchResultOfCommunityLiveStatus +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        hasMore

        +
        hasMore: boolean
        + +
        +
        + +

        query

        +
        query: PagedQuery
        + +
        +
        + +

        replacementContinuationToken

        +
        replacementContinuationToken: string
        + +
        +
        + +

        results

        + + +
        +
        + +

        totalResults

        +
        totalResults: number
        + +
        +
        + +

        useTotalResults

        +
        useTotalResults: boolean
        + +
        +
        +

        If useTotalResults is true, then totalResults represents an accurate count.

        +
        +

        If False, it does not, and may be estimated/only the size of the current page.

        +

        Either way, you should probably always only trust hasMore.

        +

        This is a long-held historical throwback to when we used to do paging with known + total results. Those queries toasted our database, and we were left to hastily + alter our endpoints and create backward- compatible shims, of which + useTotalResults is one.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/searchresultofcontentitempubliccontract.html b/docs/interfaces/searchresultofcontentitempubliccontract.html new file mode 100644 index 0000000..badf7a6 --- /dev/null +++ b/docs/interfaces/searchresultofcontentitempubliccontract.html @@ -0,0 +1,275 @@ + + + + + + SearchResultOfContentItemPublicContract | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface SearchResultOfContentItemPublicContract

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + SearchResultOfContentItemPublicContract +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        hasMore

        +
        hasMore: boolean
        + +
        +
        + +

        query

        +
        query: PagedQuery
        + +
        +
        + +

        replacementContinuationToken

        +
        replacementContinuationToken: string
        + +
        +
        + +

        results

        + + +
        +
        + +

        totalResults

        +
        totalResults: number
        + +
        +
        + +

        useTotalResults

        +
        useTotalResults: boolean
        + +
        +
        +

        If useTotalResults is true, then totalResults represents an accurate count.

        +
        +

        If False, it does not, and may be estimated/only the size of the current page.

        +

        Either way, you should probably always only trust hasMore.

        +

        This is a long-held historical throwback to when we used to do paging with known + total results. Those queries toasted our database, and we were left to hastily + alter our endpoints and create backward- compatible shims, of which + useTotalResults is one.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/searchresultofdestinyentitysearchresultitem.html b/docs/interfaces/searchresultofdestinyentitysearchresultitem.html new file mode 100644 index 0000000..7bf7870 --- /dev/null +++ b/docs/interfaces/searchresultofdestinyentitysearchresultitem.html @@ -0,0 +1,275 @@ + + + + + + SearchResultOfDestinyEntitySearchResultItem | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface SearchResultOfDestinyEntitySearchResultItem

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + SearchResultOfDestinyEntitySearchResultItem +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        hasMore

        +
        hasMore: boolean
        + +
        +
        + +

        query

        +
        query: PagedQuery
        + +
        +
        + +

        replacementContinuationToken

        +
        replacementContinuationToken: string
        + +
        +
        + +

        results

        + + +
        +
        + +

        totalResults

        +
        totalResults: number
        + +
        +
        + +

        useTotalResults

        +
        useTotalResults: boolean
        + +
        +
        +

        If useTotalResults is true, then totalResults represents an accurate count.

        +
        +

        If False, it does not, and may be estimated/only the size of the current page.

        +

        Either way, you should probably always only trust hasMore.

        +

        This is a long-held historical throwback to when we used to do paging with known + total results. Those queries toasted our database, and we were left to hastily + alter our endpoints and create backward- compatible shims, of which + useTotalResults is one.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/searchresultoffireteamresponse.html b/docs/interfaces/searchresultoffireteamresponse.html new file mode 100644 index 0000000..8f2f5f7 --- /dev/null +++ b/docs/interfaces/searchresultoffireteamresponse.html @@ -0,0 +1,275 @@ + + + + + + SearchResultOfFireteamResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface SearchResultOfFireteamResponse

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + SearchResultOfFireteamResponse +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        hasMore

        +
        hasMore: boolean
        + +
        +
        + +

        query

        +
        query: PagedQuery
        + +
        +
        + +

        replacementContinuationToken

        +
        replacementContinuationToken: string
        + +
        +
        + +

        results

        +
        results: FireteamResponse[]
        + +
        +
        + +

        totalResults

        +
        totalResults: number
        + +
        +
        + +

        useTotalResults

        +
        useTotalResults: boolean
        + +
        +
        +

        If useTotalResults is true, then totalResults represents an accurate count.

        +
        +

        If False, it does not, and may be estimated/only the size of the current page.

        +

        Either way, you should probably always only trust hasMore.

        +

        This is a long-held historical throwback to when we used to do paging with known + total results. Those queries toasted our database, and we were left to hastily + alter our endpoints and create backward- compatible shims, of which + useTotalResults is one.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/searchresultoffireteamsummary.html b/docs/interfaces/searchresultoffireteamsummary.html new file mode 100644 index 0000000..19c292e --- /dev/null +++ b/docs/interfaces/searchresultoffireteamsummary.html @@ -0,0 +1,275 @@ + + + + + + SearchResultOfFireteamSummary | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface SearchResultOfFireteamSummary

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + SearchResultOfFireteamSummary +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        hasMore

        +
        hasMore: boolean
        + +
        +
        + +

        query

        +
        query: PagedQuery
        + +
        +
        + +

        replacementContinuationToken

        +
        replacementContinuationToken: string
        + +
        +
        + +

        results

        +
        results: FireteamSummary[]
        + +
        +
        + +

        totalResults

        +
        totalResults: number
        + +
        +
        + +

        useTotalResults

        +
        useTotalResults: boolean
        + +
        +
        +

        If useTotalResults is true, then totalResults represents an accurate count.

        +
        +

        If False, it does not, and may be estimated/only the size of the current page.

        +

        Either way, you should probably always only trust hasMore.

        +

        This is a long-held historical throwback to when we used to do paging with known + total results. Those queries toasted our database, and we were left to hastily + alter our endpoints and create backward- compatible shims, of which + useTotalResults is one.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/searchresultofgroupban.html b/docs/interfaces/searchresultofgroupban.html new file mode 100644 index 0000000..ebb438a --- /dev/null +++ b/docs/interfaces/searchresultofgroupban.html @@ -0,0 +1,275 @@ + + + + + + SearchResultOfGroupBan | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface SearchResultOfGroupBan

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + SearchResultOfGroupBan +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        hasMore

        +
        hasMore: boolean
        + +
        +
        + +

        query

        +
        query: PagedQuery
        + +
        +
        + +

        replacementContinuationToken

        +
        replacementContinuationToken: string
        + +
        +
        + +

        results

        +
        results: GroupBan[]
        + +
        +
        + +

        totalResults

        +
        totalResults: number
        + +
        +
        + +

        useTotalResults

        +
        useTotalResults: boolean
        + +
        +
        +

        If useTotalResults is true, then totalResults represents an accurate count.

        +
        +

        If False, it does not, and may be estimated/only the size of the current page.

        +

        Either way, you should probably always only trust hasMore.

        +

        This is a long-held historical throwback to when we used to do paging with known + total results. Those queries toasted our database, and we were left to hastily + alter our endpoints and create backward- compatible shims, of which + useTotalResults is one.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/searchresultofgroupmember.html b/docs/interfaces/searchresultofgroupmember.html new file mode 100644 index 0000000..276a584 --- /dev/null +++ b/docs/interfaces/searchresultofgroupmember.html @@ -0,0 +1,275 @@ + + + + + + SearchResultOfGroupMember | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface SearchResultOfGroupMember

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + SearchResultOfGroupMember +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        hasMore

        +
        hasMore: boolean
        + +
        +
        + +

        query

        +
        query: PagedQuery
        + +
        +
        + +

        replacementContinuationToken

        +
        replacementContinuationToken: string
        + +
        +
        + +

        results

        +
        results: GroupMember[]
        + +
        +
        + +

        totalResults

        +
        totalResults: number
        + +
        +
        + +

        useTotalResults

        +
        useTotalResults: boolean
        + +
        +
        +

        If useTotalResults is true, then totalResults represents an accurate count.

        +
        +

        If False, it does not, and may be estimated/only the size of the current page.

        +

        Either way, you should probably always only trust hasMore.

        +

        This is a long-held historical throwback to when we used to do paging with known + total results. Those queries toasted our database, and we were left to hastily + alter our endpoints and create backward- compatible shims, of which + useTotalResults is one.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/searchresultofgroupmemberapplication.html b/docs/interfaces/searchresultofgroupmemberapplication.html new file mode 100644 index 0000000..806b149 --- /dev/null +++ b/docs/interfaces/searchresultofgroupmemberapplication.html @@ -0,0 +1,275 @@ + + + + + + SearchResultOfGroupMemberApplication | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface SearchResultOfGroupMemberApplication

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + SearchResultOfGroupMemberApplication +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        hasMore

        +
        hasMore: boolean
        + +
        +
        + +

        query

        +
        query: PagedQuery
        + +
        +
        + +

        replacementContinuationToken

        +
        replacementContinuationToken: string
        + +
        +
        + +

        results

        + + +
        +
        + +

        totalResults

        +
        totalResults: number
        + +
        +
        + +

        useTotalResults

        +
        useTotalResults: boolean
        + +
        +
        +

        If useTotalResults is true, then totalResults represents an accurate count.

        +
        +

        If False, it does not, and may be estimated/only the size of the current page.

        +

        Either way, you should probably always only trust hasMore.

        +

        This is a long-held historical throwback to when we used to do paging with known + total results. Those queries toasted our database, and we were left to hastily + alter our endpoints and create backward- compatible shims, of which + useTotalResults is one.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/searchresultoftrendingentry.html b/docs/interfaces/searchresultoftrendingentry.html new file mode 100644 index 0000000..22c99a8 --- /dev/null +++ b/docs/interfaces/searchresultoftrendingentry.html @@ -0,0 +1,275 @@ + + + + + + SearchResultOfTrendingEntry | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface SearchResultOfTrendingEntry

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + SearchResultOfTrendingEntry +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        hasMore

        +
        hasMore: boolean
        + +
        +
        + +

        query

        +
        query: PagedQuery
        + +
        +
        + +

        replacementContinuationToken

        +
        replacementContinuationToken: string
        + +
        +
        + +

        results

        +
        results: TrendingEntry[]
        + +
        +
        + +

        totalResults

        +
        totalResults: number
        + +
        +
        + +

        useTotalResults

        +
        useTotalResults: boolean
        + +
        +
        +

        If useTotalResults is true, then totalResults represents an accurate count.

        +
        +

        If False, it does not, and may be estimated/only the size of the current page.

        +

        Either way, you should probably always only trust hasMore.

        +

        This is a long-held historical throwback to when we used to do paging with known + total results. Those queries toasted our database, and we were left to hastily + alter our endpoints and create backward- compatible shims, of which + useTotalResults is one.

        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/series.html b/docs/interfaces/series.html new file mode 100644 index 0000000..e8a2967 --- /dev/null +++ b/docs/interfaces/series.html @@ -0,0 +1,218 @@ + + + + + + Series | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface Series

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + Series +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        datapoints

        +
        datapoints: Datapoint[]
        + +
        +
        +

        Collection of samples with time and value.

        +
        +
        +
        +
        + +

        target

        +
        target: string
        + +
        +
        +

        Target to which to datapoints apply.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/serverresponse.html b/docs/interfaces/serverresponse.html new file mode 100644 index 0000000..ed2ea3e --- /dev/null +++ b/docs/interfaces/serverresponse.html @@ -0,0 +1,293 @@ + + + + + + ServerResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface ServerResponse<T>

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Bungie.Net API + These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.

        +
        +

        OpenAPI spec version: 2.3.5 + Contact: support@bungie.com

        +

        NOTE: This class is auto generated by the bungie-api-ts code generator program. + https://github.com/DestinyItemManager/bugie-api-ts + Do not edit these files manually.

        +
        +
        +
        +

        Type parameters

        +
          +
        • +

          T

          +
        • +
        +
        +
        +

        Hierarchy

        +
          +
        • + ServerResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        ErrorCode

        + + +
        +
        + +

        ErrorStatus

        +
        ErrorStatus: string
        + +
        +
        + +

        Message

        +
        Message: string
        + +
        +
        + +

        MessageData

        +
        MessageData: object
        + +
        +

        Type declaration

        +
          +
        • +
          [key: string]: string
          +
        • +
        +
        +
        +
        + +

        Response

        +
        Response: T
        + +
        +
        + +

        ThrottleSeconds

        +
        ThrottleSeconds: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/singlecomponentresponse.html b/docs/interfaces/singlecomponentresponse.html new file mode 100644 index 0000000..4fb3d68 --- /dev/null +++ b/docs/interfaces/singlecomponentresponse.html @@ -0,0 +1,216 @@ + + + + + + SingleComponentResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface SingleComponentResponse<T>

        +
        +
        +
        +
        +
        +
        +
        +

        Type parameters

        +
          +
        • +

          T

          +
        • +
        +
        +
        +

        Hierarchy

        +
          +
        • + SingleComponentResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        data

        +
        data: T
        + +
        +
        + +

        privacy

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/streaminfo.html b/docs/interfaces/streaminfo.html new file mode 100644 index 0000000..a4bf3c6 --- /dev/null +++ b/docs/interfaces/streaminfo.html @@ -0,0 +1,194 @@ + + + + + + StreamInfo | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface StreamInfo

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + StreamInfo +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        ChannelName

        +
        ChannelName: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/tagmetadatadefinition.html b/docs/interfaces/tagmetadatadefinition.html new file mode 100644 index 0000000..0c6d565 --- /dev/null +++ b/docs/interfaces/tagmetadatadefinition.html @@ -0,0 +1,264 @@ + + + + + + TagMetadataDefinition | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface TagMetadataDefinition

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + TagMetadataDefinition +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        datatype

        +
        datatype: string
        + +
        +
        + +

        description

        +
        description: string
        + +
        +
        + +

        isRequired

        +
        isRequired: boolean
        + +
        +
        + +

        items

        + + +
        +
        + +

        name

        +
        name: string
        + +
        +
        + +

        order

        +
        order: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/tagmetadataitem.html b/docs/interfaces/tagmetadataitem.html new file mode 100644 index 0000000..5e0f249 --- /dev/null +++ b/docs/interfaces/tagmetadataitem.html @@ -0,0 +1,250 @@ + + + + + + TagMetadataItem | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface TagMetadataItem

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + TagMetadataItem +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        description

        +
        description: string
        + +
        +
        + +

        groups

        +
        groups: string[]
        + +
        +
        + +

        isDefault

        +
        isDefault: boolean
        + +
        +
        + +

        name

        +
        name: string
        + +
        +
        + +

        tagText

        +
        tagText: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/tagresponse.html b/docs/interfaces/tagresponse.html new file mode 100644 index 0000000..ea3a66f --- /dev/null +++ b/docs/interfaces/tagresponse.html @@ -0,0 +1,208 @@ + + + + + + TagResponse | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface TagResponse

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + TagResponse +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        ignoreStatus

        +
        ignoreStatus: IgnoreResponse
        + +
        +
        + +

        tagText

        +
        tagText: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/travelerconfig.html b/docs/interfaces/travelerconfig.html new file mode 100644 index 0000000..2290ac3 --- /dev/null +++ b/docs/interfaces/travelerconfig.html @@ -0,0 +1,261 @@ + + + + + + TravelerConfig | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface TravelerConfig

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Interface for defining an object for the Traveler class

        +
        +
        +
        interface
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + TravelerConfig +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        apikey

        +
        apikey: string
        + +
        +
        + +

        Optional debug

        +
        debug: boolean
        + +
        +
        + +

        Optional oauthClientId

        +
        oauthClientId: string
        + +
        +
        + +

        Optional oauthClientSecret

        +
        oauthClientSecret: string
        + +
        +
        + +

        userAgent

        +
        userAgent: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/trendingcategories.html b/docs/interfaces/trendingcategories.html new file mode 100644 index 0000000..6c8a380 --- /dev/null +++ b/docs/interfaces/trendingcategories.html @@ -0,0 +1,194 @@ + + + + + + TrendingCategories | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface TrendingCategories

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + TrendingCategories +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        categories

        +
        categories: TrendingCategory[]
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/trendingcategory.html b/docs/interfaces/trendingcategory.html new file mode 100644 index 0000000..ad9d790 --- /dev/null +++ b/docs/interfaces/trendingcategory.html @@ -0,0 +1,222 @@ + + + + + + TrendingCategory | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface TrendingCategory

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + TrendingCategory +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        categoryId

        +
        categoryId: string
        + +
        +
        + +

        categoryName

        +
        categoryName: string
        + +
        +
        + +

        entries

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/trendingdetail.html b/docs/interfaces/trendingdetail.html new file mode 100644 index 0000000..25f821d --- /dev/null +++ b/docs/interfaces/trendingdetail.html @@ -0,0 +1,306 @@ + + + + + + TrendingDetail | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface TrendingDetail

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + TrendingDetail +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        creation

        + + +
        +
        + +

        destinyActivity

        + + +
        +
        + +

        destinyItem

        + + +
        +
        + +

        destinyRitual

        + + +
        +
        + +

        entityType

        +
        entityType: TrendingEntryType
        + +
        +
        + +

        identifier

        +
        identifier: string
        + +
        +
        + +

        news

        + + +
        +
        + +

        stream

        + + +
        +
        + +

        support

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/trendingentry.html b/docs/interfaces/trendingentry.html new file mode 100644 index 0000000..573b1db --- /dev/null +++ b/docs/interfaces/trendingentry.html @@ -0,0 +1,461 @@ + + + + + + TrendingEntry | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface TrendingEntry

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        The list entry view for trending items. Returns just enough to show the item on + the trending page.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + TrendingEntry +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        Optional creationDate

        +
        creationDate: string
        + +
        +
        +

        If the entry has a date at which it was created, this is that date.

        +
        +
        +
        +
        + +

        displayName

        +
        displayName: string
        + +
        +
        +

        The localized "display name/article title/'primary localized identifier'" of the + entity.

        +
        +
        +
        +
        + +

        Optional endDate

        +
        endDate: string
        + +
        +
        + +

        entityType

        +
        entityType: TrendingEntryType
        + +
        +
        +

        An enum - unfortunately - dictating all of the possible kinds of trending items + that you might get in your result set, in case you want to do custom rendering + or call to get the details of the item.

        +
        +
        +
        +
        + +

        featureImage

        +
        featureImage: string
        + +
        +
        +

        If isFeatured, this image will be populated with whatever the featured image is. + Note that this will likely be a very large image, so don't use it all the time.

        +
        +
        +
        +
        + +

        identifier

        +
        identifier: string
        + +
        +
        +

        We don't know whether the identifier will be a string, a uint, or a long... so + we're going to cast it all to a string. But either way, we need any trending + item created to have a single unique identifier for its type.

        +
        +
        +
        +
        + +

        image

        +
        image: string
        + +
        +
        + +

        isFeatured

        +
        isFeatured: boolean
        + +
        +
        + +

        items

        +
        items: TrendingEntry[]
        + +
        +
        +

        If the item is of entityType TrendingEntryType.Container, it may have items - + also Trending Entries - contained within it. This is the ordered list of those + to display under the Container's header.

        +
        +
        +
        +
        + +

        link

        +
        link: string
        + +
        +
        + +

        mp4Video

        +
        mp4Video: string
        + +
        +
        +

        If this is populated, the entry has a related MP4 video to show. I am 100% + certain I am going to regret putting this directly on TrendingEntry, but it will + work so yolo

        +
        +
        +
        +
        + +

        Optional startDate

        +
        startDate: string
        + +
        +
        + +

        tagline

        +
        tagline: string
        + +
        +
        +

        If the entity has a localized tagline/subtitle/motto/whatever, that is found + here.

        +
        +
        +
        +
        + +

        webmVideo

        +
        webmVideo: string
        + +
        +
        +

        If this is populated, the entry has a related WebM video to show. I am 100% + certain I am going to regret putting this directly on TrendingEntry, but it will + work so yolo

        +
        +
        +
        +
        + +

        weight

        +
        weight: number
        + +
        +
        +

        The weighted score of this trending item.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/trendingentrycommunitycreation.html b/docs/interfaces/trendingentrycommunitycreation.html new file mode 100644 index 0000000..806c1d3 --- /dev/null +++ b/docs/interfaces/trendingentrycommunitycreation.html @@ -0,0 +1,278 @@ + + + + + + TrendingEntryCommunityCreation | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface TrendingEntryCommunityCreation

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + TrendingEntryCommunityCreation +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        author

        +
        author: string
        + +
        +
        + +

        authorMembershipId

        +
        authorMembershipId: string
        + +
        +
        + +

        body

        +
        body: string
        + +
        +
        + +

        media

        +
        media: string
        + +
        +
        + +

        postId

        +
        postId: string
        + +
        +
        + +

        title

        +
        title: string
        + +
        +
        + +

        upvotes

        +
        upvotes: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/trendingentrycommunitystream.html b/docs/interfaces/trendingentrycommunitystream.html new file mode 100644 index 0000000..1d492a2 --- /dev/null +++ b/docs/interfaces/trendingentrycommunitystream.html @@ -0,0 +1,236 @@ + + + + + + TrendingEntryCommunityStream | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface TrendingEntryCommunityStream

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + TrendingEntryCommunityStream +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        image

        +
        image: string
        + +
        +
        + +

        partnershipIdentifier

        +
        partnershipIdentifier: string
        + +
        +
        + +

        partnershipType

        +
        partnershipType: PartnershipType
        + +
        +
        + +

        title

        +
        title: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/trendingentrydestinyactivity.html b/docs/interfaces/trendingentrydestinyactivity.html new file mode 100644 index 0000000..c8f512c --- /dev/null +++ b/docs/interfaces/trendingentrydestinyactivity.html @@ -0,0 +1,208 @@ + + + + + + TrendingEntryDestinyActivity | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface TrendingEntryDestinyActivity

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + TrendingEntryDestinyActivity +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        activityHash

        +
        activityHash: number
        + +
        +
        + +

        status

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/trendingentrydestinyitem.html b/docs/interfaces/trendingentrydestinyitem.html new file mode 100644 index 0000000..503afe3 --- /dev/null +++ b/docs/interfaces/trendingentrydestinyitem.html @@ -0,0 +1,194 @@ + + + + + + TrendingEntryDestinyItem | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface TrendingEntryDestinyItem

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + TrendingEntryDestinyItem +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        itemHash

        +
        itemHash: number
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/trendingentrydestinyritual.html b/docs/interfaces/trendingentrydestinyritual.html new file mode 100644 index 0000000..e994891 --- /dev/null +++ b/docs/interfaces/trendingentrydestinyritual.html @@ -0,0 +1,304 @@ + + + + + + TrendingEntryDestinyRitual | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface TrendingEntryDestinyRitual

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + TrendingEntryDestinyRitual +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        Optional dateEnd

        +
        dateEnd: string
        + +
        +
        + +

        Optional dateStart

        +
        dateStart: string
        + +
        +
        + +

        eventContent

        + + +
        +
        +

        A destiny event will not necessarily have milestone "custom content", but if it + does the details will be here.

        +
        +
        +
        +
        + +

        icon

        +
        icon: string
        + +
        +
        + +

        image

        +
        image: string
        + +
        +
        + +

        milestoneDetails

        +
        milestoneDetails: DestinyPublicMilestone
        + +
        +
        +

        A destiny event does not necessarily have a related Milestone, but if it does + the details will be returned here.

        +
        +
        +
        +
        + +

        subtitle

        +
        subtitle: string
        + +
        +
        + +

        title

        +
        title: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/trendingentrynews.html b/docs/interfaces/trendingentrynews.html new file mode 100644 index 0000000..eb4e8e3 --- /dev/null +++ b/docs/interfaces/trendingentrynews.html @@ -0,0 +1,194 @@ + + + + + + TrendingEntryNews | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface TrendingEntryNews

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + TrendingEntryNews +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        article

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/trendingentrysupportarticle.html b/docs/interfaces/trendingentrysupportarticle.html new file mode 100644 index 0000000..53062b5 --- /dev/null +++ b/docs/interfaces/trendingentrysupportarticle.html @@ -0,0 +1,194 @@ + + + + + + TrendingEntrySupportArticle | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface TrendingEntrySupportArticle

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + TrendingEntrySupportArticle +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        article

        + + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/userinfocard.html b/docs/interfaces/userinfocard.html new file mode 100644 index 0000000..b68c358 --- /dev/null +++ b/docs/interfaces/userinfocard.html @@ -0,0 +1,289 @@ + + + + + + UserInfoCard | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface UserInfoCard

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        This contract supplies basic information commonly used to display a minimal + amount of information about a user. Take care to not add more properties here + unless the property applies in all (or at least the majority) of the situations + where UserInfoCard is used. Avoid adding game specific or platform specific + details here. In cases where UserInfoCard is a subset of the data needed in a + contract, use UserInfoCard as a property of other contracts.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + UserInfoCard +
        • +
        +
        +
        +

        Index

        +
        + +
        +
        +
        +

        Properties

        +
        + +

        displayName

        +
        displayName: string
        + +
        +
        +

        Display Name the player has chosen for themselves. The display name is optional + when the data type is used as input to a platform API.

        +
        +
        +
        +
        + +

        iconPath

        +
        iconPath: string
        + +
        +
        +

        URL the Icon if available.

        +
        +
        +
        +
        + +

        membershipId

        +
        membershipId: string
        + +
        +
        +

        Membership ID as they user is known in the Accounts service

        +
        +
        +
        +
        + +

        membershipType

        +
        membershipType: BungieMembershipType
        + +
        +
        +

        Type of the membership.

        +
        +
        +
        +
        + +

        supplementalDisplayName

        +
        supplementalDisplayName: string
        + +
        +
        +

        A platform specific additional display name - ex: psn Real Name, bnet Unique + Name, etc.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/usermembership.html b/docs/interfaces/usermembership.html new file mode 100644 index 0000000..86d5032 --- /dev/null +++ b/docs/interfaces/usermembership.html @@ -0,0 +1,245 @@ + + + + + + UserMembership | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface UserMembership

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Very basic info about a user as returned by the Account server.

        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + UserMembership +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        displayName

        +
        displayName: string
        + +
        +
        +

        Display Name the player has chosen for themselves. The display name is optional + when the data type is used as input to a platform API.

        +
        +
        +
        +
        + +

        membershipId

        +
        membershipId: string
        + +
        +
        +

        Membership ID as they user is known in the Accounts service

        +
        +
        +
        +
        + +

        membershipType

        +
        membershipType: BungieMembershipType
        + +
        +
        +

        Type of the membership.

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/usermembershipdata.html b/docs/interfaces/usermembershipdata.html new file mode 100644 index 0000000..c827d42 --- /dev/null +++ b/docs/interfaces/usermembershipdata.html @@ -0,0 +1,214 @@ + + + + + + UserMembershipData | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface UserMembershipData

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + UserMembershipData +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        bungieNetUser

        +
        bungieNetUser: GeneralUser
        + +
        +
        + +

        destinyMemberships

        +
        destinyMemberships: UserInfoCard[]
        + +
        +
        +

        this allows you to see destiny memberships that are visible and linked to this + account (regardless of whether or not they have characters on the world server)

        +
        +
        +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/usertheme.html b/docs/interfaces/usertheme.html new file mode 100644 index 0000000..9e3950a --- /dev/null +++ b/docs/interfaces/usertheme.html @@ -0,0 +1,222 @@ + + + + + + UserTheme | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface UserTheme

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + UserTheme +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        userThemeDescription

        +
        userThemeDescription: string
        + +
        +
        + +

        userThemeId

        +
        userThemeId: number
        + +
        +
        + +

        userThemeName

        +
        userThemeName: string
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/interfaces/usertousercontext.html b/docs/interfaces/usertousercontext.html new file mode 100644 index 0000000..d0ba0da --- /dev/null +++ b/docs/interfaces/usertousercontext.html @@ -0,0 +1,222 @@ + + + + + + UserToUserContext | The Traveler + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
        • +
        • Public/Protected
        • +
        • All
        • +
        +
        + + + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Interface UserToUserContext

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + UserToUserContext +
        • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Properties

        + +
        +
        +
        +
        +
        +

        Properties

        +
        + +

        Optional globalIgnoreEndDate

        +
        globalIgnoreEndDate: string
        + +
        +
        + +

        ignoreStatus

        +
        ignoreStatus: IgnoreResponse
        + +
        +
        + +

        isFollowing

        +
        isFollowing: boolean
        + +
        +
        +
        + +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
        • +
        • Object literal
        • +
        • Variable
        • +
        • Function
        • +
        • Function with type parameter
        • +
        • Index signature
        • +
        • Type alias
        • +
        +
          +
        • Enumeration
        • +
        • Enumeration member
        • +
        • Property
        • +
        • Method
        • +
        +
          +
        • Interface
        • +
        • Interface with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Index signature
        • +
        +
          +
        • Class
        • +
        • Class with type parameter
        • +
        • Constructor
        • +
        • Property
        • +
        • Method
        • +
        • Accessor
        • +
        • Index signature
        • +
        +
          +
        • Inherited constructor
        • +
        • Inherited property
        • +
        • Inherited method
        • +
        • Inherited accessor
        • +
        +
          +
        • Protected property
        • +
        • Protected method
        • +
        • Protected accessor
        • +
        +
          +
        • Private property
        • +
        • Private method
        • +
        • Private accessor
        • +
        +
          +
        • Static property
        • +
        • Static method
        • +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/package.json b/package.json index 4aca50a..af68a6a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "the-traveler", - "version": "1.0.0", + "version": "1.0.1", "description": "A Node.js API wrapper for the Destiny 2 API", "keywords": [ "destiny2", @@ -35,7 +35,8 @@ "test": "jest --coverage", "posttest": "codecov", "doc": "typedoc --target ES5 --readme ./README.md --name 'The Traveler' --mode file --out ./docs/ --hideGenerator --exclude **/node_modules/** ./src/**/**.ts --ignoreCompilerErrors && touch ./docs/.nojekyll", - "package": "npm pack" + "package": "npm pack", + "release": "yarn test && yarn doc && yarn build && npm publish" }, "dependencies": { "form-data": "^2.3.3", diff --git a/src/Traveler.ts b/src/Traveler.ts index 09d33d2..d101b01 100644 --- a/src/Traveler.ts +++ b/src/Traveler.ts @@ -2,7 +2,7 @@ import HTTPService from './HttpService'; import GlobalResource from './resources/GlobalResource'; import Destiny2Resource from './resources/Destiny2Resource'; import UserResource from './resources/UserResource'; -import { ITravelerConfig } from './type-definitions/additions'; +import { TravelerConfig } from './type-definitions/additions'; import OAuthResource from './resources/OAuthResource'; /** @@ -18,7 +18,7 @@ export default class Traveler { public user: UserResource; public destiny2: Destiny2Resource; - constructor(config: ITravelerConfig) { + constructor(config: TravelerConfig) { this.apikey = config.apikey; this.userAgent = config.userAgent; this.httpService = new HTTPService( diff --git a/src/type-definitions/errors.ts b/src/errors.ts similarity index 100% rename from src/type-definitions/errors.ts rename to src/errors.ts diff --git a/src/resources/Destiny2Resource.ts b/src/resources/Destiny2Resource.ts index 5470af9..a542469 100644 --- a/src/resources/Destiny2Resource.ts +++ b/src/resources/Destiny2Resource.ts @@ -5,34 +5,34 @@ import got = require('got'); import HTTPService from '../HttpService'; import BungieResource from './BungieResoure'; -import { IServerResponse } from '../type-definitions/common'; +import { ServerResponse } from '../type-definitions/common'; import { BungieMembershipType, - IDestinyCharacterResponse, - IDestinyActivityHistoryResults, - IDestinyManifest, - IDestinyDefinition, - IDestinyLinkedProfilesResponse, - IDestinyProfileResponse, - IDestinyMilestone, - IDestinyItemResponse, - IDestinyVendorsResponse, - IDestinyVendorResponse, - IDestinyCollectibleNodeDetailResponse, - IDestinyPostGameCarnageReportData, - IDestinyHistoricalStatsDefinition, - IDestinyClanAggregateStat, - IDestinyEntitySearchResult, - IDestinyHistoricalStatsByPeriod, - IDestinyHistoricalStatsAccountResult, - IDestinyActivity, - IDestinyHistoricalWeaponStatsData, - IDestinyAggregateActivityResults, - IDestinyMilestoneContent, - IDestinyPublicMilestone + DestinyCharacterResponse, + DestinyActivityHistoryResults, + DestinyManifest, + DestinyDefinition, + DestinyLinkedProfilesResponse, + DestinyProfileResponse, + DestinyMilestone, + DestinyItemResponse, + DestinyVendorsResponse, + DestinyVendorResponse, + DestinyCollectibleNodeDetailResponse, + DestinyPostGameCarnageReportData, + DestinyHistoricalStatsDefinition, + DestinyClanAggregateStat, + DestinyEntitySearchResult, + DestinyHistoricalStatsByPeriod, + DestinyHistoricalStatsAccountResult, + DestinyActivity, + DestinyHistoricalWeaponStatsData, + DestinyAggregateActivityResults, + DestinyMilestoneContent, + DestinyPublicMilestone } from '../type-definitions/destiny2'; -import { IUserInfoCard } from '../type-definitions/user'; -import { IQueryStringParameters, IDictionaryResponse, TypeDefinition } from '../type-definitions/additions'; +import { UserInfoCard } from '../type-definitions/user'; +import { QueryStringParameters, DictionaryResponse, TypeDefinition } from '../type-definitions/additions'; import { resolveQueryStringParameters } from '../util'; @@ -65,14 +65,14 @@ export default class Destiny2Resource extends BungieResource { * }); * ``` * - * @returns {Promise>} When fulfilled returns an object containing the current Destiny 2 manifest + * @returns {Promise>} When fulfilled returns an object containing the current Destiny 2 manifest * @memberof Destiny2Resource */ - public getDestinyManifest(): Promise> { - return new Promise>((resolve, reject) => { + public getDestinyManifest(): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get(`${this.resourcePath}/Manifest/`) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -109,17 +109,17 @@ export default class Destiny2Resource extends BungieResource { * ``` * @param {string} typeDefinition * @param {string} hashIdentifier - * @returns {Promise>} + * @returns {Promise>} * @memberof Destiny2Resource */ public getDestinyEntityDefinition( typeDefinition: string, hashIdentifier: string - ): Promise> { - return new Promise>((resolve, reject) => { + ): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get(`${this.resourcePath}/Manifest/${typeDefinition}/${hashIdentifier}/`) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -157,17 +157,17 @@ export default class Destiny2Resource extends BungieResource { * Keep in mind that `-1 / MembershipType.All` is not applicable here
        * Ex: If the `destinyMembershipId` is a PSN account then use `'2'` or `MembershipType.TigerPSN` for this endpoint. * @param {string} displayName The full gamertag or PSN id of the player. Spaces and case are ignored - * @returns {Promise>} + * @returns {Promise>} * @memberof Destiny2Resource */ public searchDestinyPlayer( membershipType: BungieMembershipType, displayName: string - ): Promise> { - return new Promise>((resolve, reject) => { + ): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get(`${this.resourcePath}/SearchDestinyPlayer/${membershipType}/${displayName}/`) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -206,17 +206,17 @@ export default class Destiny2Resource extends BungieResource { * * @param {BungieMembershipType} membershipType * @param {string} destinyMembershipId - * @returns {Promise>} + * @returns {Promise>} * @memberof Destiny2Resource */ public getLinkedProfiles( membershipType: BungieMembershipType, destinyMembershipId: string - ): Promise> { - return new Promise>((resolve, reject) => { + ): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get(`${this.resourcePath}/${membershipType}/Profile/${destinyMembershipId}/LinkedProfiles/`) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -256,22 +256,22 @@ export default class Destiny2Resource extends BungieResource { * Keep in mind that `-1 / MembershipType.All` is not applicable here
        * Ex: If the `destinyMembershipId` is a PSN account then use `'2'` or `MembershipType.TigerPSN` for this endpoint. * @param {string} destinyMembershipId The Destiny ID (Account ID) - * @param {IQueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: + * @param {QueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: *
          *
        • components {string[]}: See {@link https://bungie-net.github.io/multi/schema_Destiny-DestinyComponentType.html#schema_Destiny-DestinyComponentType|DestinyComponentType} for the different enum types.
        • *
        You must request at least one component to receive results. * @param {string} [oauthAccesstoken] Optional access token to request data with an oauth scopes - * @returns {Promise>} + * @returns {Promise>} * @memberof Destiny2Resource * */ public getProfile( membershipType: BungieMembershipType, destinyMembershipId: string, - queryStringParameters: IQueryStringParameters, + queryStringParameters: QueryStringParameters, oauthAccesstoken?: string - ): Promise> { - return new Promise>((resolve, reject) => { + ): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get( `${this.resourcePath}/${membershipType}/Profile/${destinyMembershipId}/${resolveQueryStringParameters( @@ -279,7 +279,7 @@ export default class Destiny2Resource extends BungieResource { )}`, oauthAccesstoken ) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -329,22 +329,22 @@ export default class Destiny2Resource extends BungieResource { * Ex: If the `destinyMembershipId` is a PSN account then use `'2'` or `MembershipType.TigerPSN` for this endpoint. * @param {string} destinyMembershipId Destiny membership ID. * @param {string} characterId ID of the character. - * @param {IQueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: + * @param {QueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: *
          *
        • components {string[]}: See {@link https://bungie-net.github.io/multi/schema_Destiny-DestinyComponentType.html#schema_Destiny-DestinyComponentType|DestinyComponentType} for the different enum types.
        • *
        You must request at least one component to receive results. * @param {string} [oauthAccesstoken] Optional oauth access token - * @returns {Promise>} + * @returns {Promise>} * @memberof Destiny2Resource */ public getCharacter( membershipType: BungieMembershipType, destinyMembershipId: string, characterId: string, - queryStringParameters: IQueryStringParameters, + queryStringParameters: QueryStringParameters, oauthAccesstoken?: string - ): Promise> { - return new Promise>((resolve, reject) => { + ): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get( `${ @@ -354,7 +354,7 @@ export default class Destiny2Resource extends BungieResource { )}`, oauthAccesstoken ) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -385,14 +385,14 @@ export default class Destiny2Resource extends BungieResource { * ``` * * @param {string} groupId A valid group id of the clan - * @returns {Promise>} When fulfilled returns an object containing information about the weekly clan results + * @returns {Promise>} When fulfilled returns an object containing information about the weekly clan results * @memberof Destiny2Resource */ - public getClanWeeklyRewardState(groupId: string): Promise> { - return new Promise>((resolve, reject) => { + public getClanWeeklyRewardState(groupId: string): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get(`${this.resourcePath}/Clan/${groupId}/WeeklyRewardState/`) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -435,20 +435,20 @@ export default class Destiny2Resource extends BungieResource { * Ex: If the `destinyMembershipId` is a PSN account then use `'2'` or `MembershipType.TigerPSN` for this endpoint. * @param {string} destinyMembershipId The Destiny ID (Account ID) * @param {string} itemInstanceId ID of the Destiny Item - * @param {IQueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: + * @param {QueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: *
          *
        • components {string[]}: See {@link https://bungie-net.github.io/multi/schema_Destiny-DestinyComponentType.html#schema_Destiny-DestinyComponentType|DestinyComponentType} for the different enum types.
        • *
        You must request at least one component to receive results. - * @returns {Promise>} When fulfilled returns an object containing stats about the queried item + * @returns {Promise>} When fulfilled returns an object containing stats about the queried item * @memberof Destiny2Resource */ public getItem( membershipType: BungieMembershipType, destinyMembershipId: string, itemInstanceId: string, - queryStringParameters: IQueryStringParameters - ): Promise> { - return new Promise>((resolve, reject) => { + queryStringParameters: QueryStringParameters + ): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get( `${ @@ -457,7 +457,7 @@ export default class Destiny2Resource extends BungieResource { queryStringParameters )}` ) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -503,22 +503,22 @@ export default class Destiny2Resource extends BungieResource { * Ex: If the `destinyMembershipId` is a PSN account then use `'2'` or `MembershipType.TigerPSN` for this endpoint. * @param {string} destinyMembershipId Destiny membership ID of another user. You may be denied. * @param {string} characterId The Destiny Character ID of the character for whom we're getting vendor info. - * @param {IQueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: + * @param {QueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: *
          *
        • components {string[]}: See {@link https://bungie-net.github.io/multi/schema_Destiny-DestinyComponentType.html#schema_Destiny-DestinyComponentType|DestinyComponentType} for the different enum types.
        • *
        You must request at least one component to receive results. * @param {string} [oauthAccesstoken] Optional oauth access toen - * @returns {Promise>} When fulfilled returns an object containing all available vendors + * @returns {Promise>} When fulfilled returns an object containing all available vendors * @memberof Destiny2Resource */ public getVendors( membershipType: BungieMembershipType, destinyMembershipId: string, characterId: string, - queryStringParameters: IQueryStringParameters, + queryStringParameters: QueryStringParameters, oauthAccesstoken: string - ): Promise> { - return new Promise>((resolve, reject) => { + ): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get( `${ @@ -528,7 +528,58 @@ export default class Destiny2Resource extends BungieResource { )}`, oauthAccesstoken ) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { + resolve(response); + }) + .catch(err => { + reject(err); + }); + }); + } + + /** + * Get items available from vendors where the vendors have items for sale that are common for everyone. + * If any portion of the Vendor's available inventory is character or account specific, we will be unable to return their data from this endpoint due to the way that available inventory is computed. + * As I am often guilty of saying: 'It's a long story...' + * + * ```js + * import Traveler from './Traveler'; + * import { BungieMembershipType } from 'the-traveler/type-definitions/app'; + * import { DestinyComponentType } from 'the-traveler/type-definitions/destiny2'; + * + * let traveler = new Traveler({ + * apikey: 'apikey', + * userAgent: 'useragent', //used to identify your request to the API + * }); + * + * traveler.destiny2 + * .getPublicVendors( + * { + * components: [DestinyComponentType.Vendors] + * } + * ) + * .then(response => { + * console.log(response); + * }) + * .catch(err => { + * console.log(err); + * }); + * ``` + * + * @param {QueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: + *
          + *
        • components {string[]}: See {@link https://bungie-net.github.io/multi/schema_Destiny-DestinyComponentType.html#schema_Destiny-DestinyComponentType|DestinyComponentType} for the different enum types.
        • + *
        You must request at least one component to receive results. + * @returns {Promise>} When fulfilled returns an object containing all valid components for the public Vendors endpoint + * @memberof Destiny2Resource + */ + public getPublicVendors( + queryStringParameters: QueryStringParameters + ): Promise> { + return new Promise>((resolve, reject) => { + this.httpService + .get(`${this.resourcePath}/Vendors/${resolveQueryStringParameters(queryStringParameters)}`) + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -550,7 +601,7 @@ export default class Destiny2Resource extends BungieResource { *
          *
        • components {string[]}: See {@link https://bungie-net.github.io/multi/schema_Destiny-DestinyComponentType.html#schema_Destiny-DestinyComponentType|DestinyComponentType} for the different enum types.
        • *
        You must request at least one component to receive results. - * @return {Promise.IAPIResponse} When fulfilled returns an object containing all available vendors + * @return {Promise.IAPIResponse} When fulfilled returns an object containing all available vendors */ /** @@ -591,11 +642,11 @@ export default class Destiny2Resource extends BungieResource { * @param {string} destinyMembershipId Destiny membership ID of another user. You may be denied. * @param {string} characterId The Destiny Character ID of the character for whom we're getting vendor info. * @param {string} vendorHash The Hash identifier of the Vendor to be returned. - * @param {IQueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: + * @param {QueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: *
          *
        • components {string[]}: See {@link https://bungie-net.github.io/multi/schema_Destiny-DestinyComponentType.html#schema_Destiny-DestinyComponentType|DestinyComponentType} for the different enum types.
        • *
        You must request at least one component to receive results. - * @returns {Promise>} + * @returns {Promise>} * @memberof Destiny2Resource */ public getVendor( @@ -603,10 +654,10 @@ export default class Destiny2Resource extends BungieResource { destinyMembershipId: string, characterId: string, vendorHash: string, - queryStringParameters: IQueryStringParameters, + queryStringParameters: QueryStringParameters, oauthAccesstoken: string - ): Promise> { - return new Promise>((resolve, reject) => { + ): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get( `${ @@ -616,7 +667,7 @@ export default class Destiny2Resource extends BungieResource { )}`, oauthAccesstoken ) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -661,11 +712,11 @@ export default class Destiny2Resource extends BungieResource { * @param {string} destinyMembershipId Destiny membership ID of another user. You may be denied. * @param {string} characterId The Destiny Character ID of the character for whom we're getting collectible detail info. * @param {number} collectiblePresentationNodeHash The hash identifier of the Presentation Node for whom we should return collectible details. Details will only be returned for collectibles that are direct descendants of this node. - * @param {IQueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: + * @param {QueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: *
          *
        • components {string[]}: See {@link https://bungie-net.github.io/multi/schema_Destiny-DestinyComponentType.html#schema_Destiny-DestinyComponentType|DestinyComponentType} for the different enum types.
        • *
        You must request at least one component to receive results. - * @returns {Promise>} When fulfilled returns the detailed information about a Collectible Presentation Node and any Collectibles that are direct descendants. + * @returns {Promise>} When fulfilled returns the detailed information about a Collectible Presentation Node and any Collectibles that are direct descendants. * @memberof Destiny2Resource */ public getCollectibleNodeDetails( @@ -673,10 +724,10 @@ export default class Destiny2Resource extends BungieResource { destinyMembershipId: string, characterId: string, collectiblePresentationNodeHash: number, - queryStringParameters: IQueryStringParameters, + queryStringParameters: QueryStringParameters, oauthAccesstoken: string - ): Promise> { - return new Promise>((resolve, reject) => { + ): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get( `${ @@ -686,7 +737,7 @@ export default class Destiny2Resource extends BungieResource { )}`, oauthAccesstoken ) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -717,14 +768,14 @@ export default class Destiny2Resource extends BungieResource { * ``` * * @param {string} activityId The ID of the activity whose PGCR is requested. - * @returns {Promise>} When fulfilled returns an object containing the carnage report for the specified activity + * @returns {Promise>} When fulfilled returns an object containing the carnage report for the specified activity * @memberof Destiny2Resource */ - public getPostGameCarnageReport(activityId: string): Promise> { - return new Promise>((resolve, reject) => { + public getPostGameCarnageReport(activityId: string): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get(`${this.resourcePath}/Stats/PostGameCarnageReport/${activityId}/`) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -753,16 +804,14 @@ export default class Destiny2Resource extends BungieResource { * }); * ``` * - * @returns {Promise>} + * @returns {Promise>} * @memberof Destiny2Resource */ - public getHistoricalStatsDefinition(): Promise< - IServerResponse> - > { - return new Promise>((resolve, reject) => { + public getHistoricalStatsDefinition(): Promise>> { + return new Promise>((resolve, reject) => { this.httpService .get(`${this.resourcePath}/Stats/Definition/`) - .then((response: IServerResponse>) => { + .then((response: ServerResponse>) => { resolve(response); }) .catch(err => { @@ -800,7 +849,7 @@ export default class Destiny2Resource extends BungieResource { * ``` * * @param {string} groupId Group ID of the clan whose leaderboards you wish to fetch. - * @param {IQueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: + * @param {QueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: *
          *
        • modes {strings[]} Different gameMode IDs for which to get the stats
          * See {@link https://bungie-net.github.io/multi/schema_Destiny-HistoricalStats-Definitions-DestinyActivityModeType.html#schema_Destiny-HistoricalStats-Definitions-DestinyActivityModeType|DestinyActivityModeType} for the different game mode IDs @@ -809,21 +858,21 @@ export default class Destiny2Resource extends BungieResource { *
        • * {@link https://alexanderwe.github.io/the-traveler/enums/statid.html|StatIds} for available ids
        • *
        - * @returns {Promise>} When fulfilled returns an object containing leaderboards for a clan + * @returns {Promise>} When fulfilled returns an object containing leaderboards for a clan * @memberof Destiny2Resource */ public getClanLeaderboards( groupId: string, - queryStringParameters: IQueryStringParameters - ): Promise>> { - return new Promise>>((resolve, reject) => { + queryStringParameters: QueryStringParameters + ): Promise>> { + return new Promise>>((resolve, reject) => { this.httpService .get( `${this.resourcePath}/Stats/Leaderboards/Clans/${groupId}/${resolveQueryStringParameters( queryStringParameters )}` ) - .then((response: IServerResponse>) => { + .then((response: ServerResponse>) => { resolve(response); }) .catch(err => { @@ -858,26 +907,26 @@ export default class Destiny2Resource extends BungieResource { * ``` * * @param {string} groupId Group ID of the clan whose leaderboards you wish to fetch. - * @param {IQueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: + * @param {QueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: *
          *
        • modes {string[]}: Array of game modes for which to get stats
          * See {@link https://bungie-net.github.io/multi/schema_Destiny-HistoricalStats-Definitions-DestinyActivityModeType.html#schema_Destiny-HistoricalStats-Definitions-DestinyActivityModeType|DestinyActivityModeType} for the different game mode IDs
        • *
        You must request at least one component to receive results. - * @returns {Promise>} + * @returns {Promise>} * @memberof Destiny2Resource */ public getClanAggregateStats( groupId: string, - queryStringParameters: IQueryStringParameters - ): Promise> { - return new Promise>((resolve, reject) => { + queryStringParameters: QueryStringParameters + ): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get( `${this.resourcePath}/Stats/AggregateClanStats/${groupId}/${resolveQueryStringParameters( queryStringParameters )}` ) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -921,7 +970,7 @@ export default class Destiny2Resource extends BungieResource { * * @param {BungieMembershipType} membershipType The Destiny membershipId of the user to retrieve. * @param {string} destinyMembershipId A valid non-BungieNet membership type. - * @param {IQueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: + * @param {QueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: *
          *
        • modes {strings[]} Different gameMode IDs for which to get the stats
          * See {@link https://bungie-net.github.io/multi/schema_Destiny-HistoricalStats-Definitions-DestinyActivityModeType.html#schema_Destiny-HistoricalStats-Definitions-DestinyActivityModeType|DestinyActivityModeType} for the different game mode IDs @@ -930,15 +979,15 @@ export default class Destiny2Resource extends BungieResource { *
        • * See {@link https://alexanderwe.github.io/the-traveler/enums/statid.html|StatIds} for available ids
        • *
        You must request at least one component to receive results. - * @returns {Promise>>} + * @returns {Promise>>} * @memberof Destiny2Resource */ public getLeaderboards( membershipType: BungieMembershipType, destinyMembershipId: string, - queryStringParameters: IQueryStringParameters - ): Promise>> { - return new Promise>>((resolve, reject) => { + queryStringParameters: QueryStringParameters + ): Promise>> { + return new Promise>>((resolve, reject) => { this.httpService .get( `${ @@ -947,7 +996,7 @@ export default class Destiny2Resource extends BungieResource { queryStringParameters )}` ) - .then((response: IServerResponse>) => { + .then((response: ServerResponse>) => { resolve(response); }) .catch(err => { @@ -994,7 +1043,7 @@ export default class Destiny2Resource extends BungieResource { * Ex: If the `destinyMembershipId` is a PSN account then use `'2'` or `MembershipType.TigerPSN` for this endpoint. * @param {string} destinyMembershipId The Destiny membershipId of the user to retrieve. * @param {string} characterId The specific character to build the leaderboard around for the provided Destiny Membership. - * @param {IQueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: + * @param {QueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: *
          *
        • modes {strings[]} Different gameMode IDs for which to get the stats
          * See {@link https://bungie-net.github.io/multi/schema_Destiny-HistoricalStats-Definitions-DestinyActivityModeType.html#schema_Destiny-HistoricalStats-Definitions-DestinyActivityModeType|DestinyActivityModeType} for the different game mode IDs @@ -1004,16 +1053,16 @@ export default class Destiny2Resource extends BungieResource { * //TODO: Change the link of all enums * See {@link https://alexanderwe.github.io/the-traveler/enums/statid.html|StatIds} for available ids
        • *
        You must request at least one component to receive results. - * @returns {Promise>>} + * @returns {Promise>>} * @memberof Destiny2Resource */ public getLeaderboardsForCharacter( membershipType: BungieMembershipType, destinyMembershipId: string, characterId: string, - queryStringParameters: IQueryStringParameters - ): Promise>> { - return new Promise>>((resolve, reject) => { + queryStringParameters: QueryStringParameters + ): Promise>> { + return new Promise>>((resolve, reject) => { this.httpService .get( `${ @@ -1022,7 +1071,7 @@ export default class Destiny2Resource extends BungieResource { queryStringParameters )}` ) - .then((response: IServerResponse>) => { + .then((response: ServerResponse>) => { resolve(response); }) .catch(err => { @@ -1058,26 +1107,26 @@ export default class Destiny2Resource extends BungieResource { * * @param {string} searchTerm The string to use when searching for Destiny entities. * @param {TypeDefinition} typeDefinition The type of entity for whom you would like results. These correspond to the entity's definition contract name. For instance, if you are looking for items, this property should be 'DestinyInventoryItemDefinition'. - * @param {IQueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: + * @param {QueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: *
          *
        • page {number} Page number to return, starting with 0
        • *
        - * @returns {Promise>} The entities search result + * @returns {Promise>} The entities search result * @memberof Destiny2Resource */ public searchDestinyEntities( searchTerm: string, typeDefinition: TypeDefinition, - queryStringParameters: IQueryStringParameters - ): Promise> { - return new Promise>((resolve, reject) => { + queryStringParameters: QueryStringParameters + ): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get( `${this.resourcePath}/Armory/Search/${typeDefinition}/${searchTerm}/${resolveQueryStringParameters( queryStringParameters )}` ) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -1124,7 +1173,7 @@ export default class Destiny2Resource extends BungieResource { * Ex: If the `destinyMembershipId` is a PSN account then use `'2'` or `MembershipType.TigerPSN` for this endpoint. * @param {string} destinyMembershipId The Destiny membershipId of the user to retrieve. * @param {string} characterId The id of the character to retrieve. You can omit this character ID or set it to 0 to get aggregate stats across all characters. - * @param {IQueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: + * @param {QueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: *
          *
        • dayend {string}: Last day to return when daily stats are requested. Use the format YYYY-MM-DD
        • *
        • daystart {string}: First day to return when daily stats are requested. Use the format YYYY-MM-DD
        • @@ -1138,16 +1187,16 @@ export default class Destiny2Resource extends BungieResource { * See {@link https://bungie-net.github.io/multi/schema_Destiny-HistoricalStats-Definitions-PeriodType.html#schema_Destiny-HistoricalStats-Definitions-PeriodType|PeriodType} for the different period type numbers * *
        - * @returns {Promise>>} + * @returns {Promise>>} * @memberof Destiny2Resource */ public getHistoricalStats( membershipType: BungieMembershipType, destinyMembershipId: string, characterId: string, - queryStringParameters: IQueryStringParameters - ): Promise>> { - return new Promise>>((resolve, reject) => { + queryStringParameters: QueryStringParameters + ): Promise>> { + return new Promise>>((resolve, reject) => { this.httpService .get( `${ @@ -1156,7 +1205,7 @@ export default class Destiny2Resource extends BungieResource { queryStringParameters )}` ) - .then((response: IServerResponse>) => { + .then((response: ServerResponse>) => { resolve(response); }) .catch(err => { @@ -1177,7 +1226,7 @@ export default class Destiny2Resource extends BungieResource { *
      • groups {string[]}: Group of stats to include, otherwise only general stats are returned. Use the numbers.
        / * See {@link https://bungie-net.github.io/multi/schema_Destiny-HistoricalStats-Definitions-DestinyStatsGroupType.html#schema_Destiny-HistoricalStats-Definitions-DestinyStatsGroupType|DestinyStatsGroupType} for the different IDs *
      - * @return {Promise.IAPIResponse} When fulfilled returns an object containing stats about the found user's account + * @return {Promise.IAPIResponse} When fulfilled returns an object containing stats about the found user's account */ /** @@ -1211,27 +1260,27 @@ export default class Destiny2Resource extends BungieResource { * Keep in mind that `-1 / MembershipType.All` is not applicable here
      * Ex: If the `destinyMembershipId` is a PSN account then use `'2'` or `MembershipType.TigerPSN` for this endpoint. * @param {string} destinyMembershipId The Destiny membershipId of the user to retrieve. - * @param {IQueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: + * @param {QueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: *
        *
      • groups {string[]}: Group of stats to include, otherwise only general stats are returned. Use the numbers.
        / * See {@link https://bungie-net.github.io/multi/schema_Destiny-HistoricalStats-Definitions-DestinyStatsGroupType.html#schema_Destiny-HistoricalStats-Definitions-DestinyStatsGroupType|DestinyStatsGroupType} for the different IDs *
      - * @returns {Promise>} + * @returns {Promise>} * @memberof Destiny2Resource */ public getHistoricalStatsForAccount( membershipType: BungieMembershipType, destinyMembershipId: string, - queryStringParameters: IQueryStringParameters - ): Promise> { - return new Promise>((resolve, reject) => { + queryStringParameters: QueryStringParameters + ): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get( `${this.resourcePath}/${membershipType}/Account/${destinyMembershipId}/Stats/${resolveQueryStringParameters( queryStringParameters )}` ) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -1276,7 +1325,7 @@ export default class Destiny2Resource extends BungieResource { * Ex: If the `destinyMembershipId` is a PSN account then use `'2'` or `MembershipType.TigerPSN` for this endpoint. * @param {string} destinyMembershipId The Destiny membershipId of the user to retrieve. * @param {string} characterId The id of the character to retrieve. - * @param {IQueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: + * @param {QueryStringParameters} queryStringParameters An object containing key/value query parameters for this endpoint. Following keys are valid: *
        *
      • count {number}: Number of rows to return
      • *
      • mode {number} A single game mode to get the history for the specified character.
        @@ -1284,16 +1333,16 @@ export default class Destiny2Resource extends BungieResource { *
      • *
      • page {number}: Page number to return, starting with 0
      • *
      - * @returns {Promise>} + * @returns {Promise>} * @memberof Destiny2Resource */ public getActivityHistory( membershipType: BungieMembershipType, destinyMembershipId: string, characterId: string, - queryStringParameters: IQueryStringParameters - ): Promise> { - return new Promise>((resolve, reject) => { + queryStringParameters: QueryStringParameters + ): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get( `${ @@ -1302,7 +1351,7 @@ export default class Destiny2Resource extends BungieResource { queryStringParameters )}` ) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -1342,22 +1391,22 @@ export default class Destiny2Resource extends BungieResource { * Ex: If the `destinyMembershipId` is a PSN account then use `'2'` or `MembershipType.TigerPSN` for this endpoint. * @param {string} destinyMembershipId The Destiny membershipId of the user to retrieve. * @param {string} characterId The id of the character to retrieve. - * @returns {Promise>} + * @returns {Promise>} * @memberof Destiny2Resource */ public getUniqueWeaponHistory( membershipType: BungieMembershipType, destinyMembershipId: string, characterId: string - ): Promise> { - return new Promise>((resolve, reject) => { + ): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get( `${ this.resourcePath }/${membershipType}/Account/${destinyMembershipId}/Character/${characterId}/Stats/UniqueWeapons/` ) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -1397,22 +1446,22 @@ export default class Destiny2Resource extends BungieResource { * Ex: If the `destinyMembershipId` is a PSN account then use `'2'` or `MembershipType.TigerPSN` for this endpoint. * @param {string} destinyMembershipId The Destiny membershipId of the user to retrieve. * @param {string} characterId The specific character whose activities should be returned. - * @returns {Promise>} + * @returns {Promise>} * @memberof Destiny2Resource */ public getDestinyAggregateActivityStats( membershipType: BungieMembershipType, destinyMembershipId: string, characterId: string - ): Promise> { - return new Promise>((resolve, reject) => { + ): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get( `${ this.resourcePath }/${membershipType}/Account/${destinyMembershipId}/Character/${characterId}/Stats/AggregateActivityStats/` ) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -1425,7 +1474,7 @@ export default class Destiny2Resource extends BungieResource { * Gets custom localized content for the milestone of the given hash, if it exists. * @async * @param milestoneHash The identifier for the milestone to be returned - * @return {Promise.IAPIResponse} When fulfilled returns an object containing aggregated information about recent activities + * @return {Promise.IAPIResponse} When fulfilled returns an object containing aggregated information about recent activities */ /** @@ -1452,14 +1501,14 @@ export default class Destiny2Resource extends BungieResource { * ``` * * @param {string} milestoneHash The identifier for the milestone to be returned. - * @returns {Promise>} + * @returns {Promise>} * @memberof Destiny2Resource */ - public getPublicMilestoneContent(milestoneHash: string): Promise> { - return new Promise>((resolve, reject) => { + public getPublicMilestoneContent(milestoneHash: string): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get(`${this.resourcePath}/Milestones/${milestoneHash}/Content/`) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -1488,14 +1537,14 @@ export default class Destiny2Resource extends BungieResource { * }); * ``` * - * @returns {Promise>} + * @returns {Promise>} * @memberof Destiny2Resource */ - public getPublicMilestones(): Promise>> { - return new Promise>>((resolve, reject) => { + public getPublicMilestones(): Promise>> { + return new Promise>>((resolve, reject) => { this.httpService .get(`${this.resourcePath}/Milestones/`) - .then((response: IServerResponse>) => { + .then((response: ServerResponse>) => { resolve(response); }) .catch(err => { diff --git a/src/resources/GlobalResource.ts b/src/resources/GlobalResource.ts index 2d66eaf..4e7f4d6 100644 --- a/src/resources/GlobalResource.ts +++ b/src/resources/GlobalResource.ts @@ -1,8 +1,8 @@ import BungieResource from './BungieResoure'; import HTTPService from '../HttpService'; -import { IServerResponse } from '../type-definitions/common'; -import { IGlobalAlert, IDictionaryResponse } from '../type-definitions/additions'; +import { ServerResponse } from '../type-definitions/common'; +import { GlobalAlert, DictionaryResponse } from '../type-definitions/additions'; export default class GlobalResource extends BungieResource { protected resourcePath: string; @@ -17,11 +17,11 @@ export default class GlobalResource extends BungieResource { * @async * @return {Promise.ServerResponse} When fulfilled returns a list of available localization cultures */ - public getAvailableLocales(): Promise>> { - return new Promise>>((resolve, reject) => { + public getAvailableLocales(): Promise>> { + return new Promise>>((resolve, reject) => { this.httpService .get(`${this.resourcePath}/GetAvailableLocales/`) - .then((response: IServerResponse>) => { + .then((response: ServerResponse>) => { resolve(response); }) .catch(err => { @@ -33,13 +33,13 @@ export default class GlobalResource extends BungieResource { /** * Get the common settings used by the Bungie.Net environment. * @async - * @return {Promise.IServerResponse} When fulfilled returns an object containing the common settings + * @return {Promise.ServerResponse} When fulfilled returns an object containing the common settings */ - public getCommonSettings(): Promise> { - return new Promise>((resolve, reject) => { + public getCommonSettings(): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get(`${this.resourcePath}/Settings/`) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -51,13 +51,13 @@ export default class GlobalResource extends BungieResource { /** * Gets any active global alert for display in the forum banners, help pages, etc. Usually used for DOC alerts. * @async - * @return {Promise.IServerResponse} When fulfilled returns an object containing the current Global Alerts + * @return {Promise.ServerResponse} When fulfilled returns an object containing the current Global Alerts */ - public getGlobalAlerts(): Promise> { - return new Promise>((resolve, reject) => { + public getGlobalAlerts(): Promise> { + return new Promise>((resolve, reject) => { this.httpService .get(`${this.resourcePath}/GlobalAlerts/`) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { diff --git a/src/resources/OAuthResource.ts b/src/resources/OAuthResource.ts index 668b6fd..778363b 100644 --- a/src/resources/OAuthResource.ts +++ b/src/resources/OAuthResource.ts @@ -1,14 +1,14 @@ import BungieResource from './BungieResoure'; import HTTPService from '../HttpService'; import got = require('got'); -import { IOAuthResponse, ITravelerConfig } from '../type-definitions/additions'; -import { OAuthError } from '../type-definitions/errors'; +import { OAuthResponse, TravelerConfig } from '../type-definitions/additions'; +import { OAuthError } from '../errors'; export default class OAuthResource extends BungieResource { protected resourcePath: string; private userAgent: string; - constructor(config: ITravelerConfig, httpService: HTTPService) { + constructor(config: TravelerConfig, httpService: HTTPService) { super(httpService); this.resourcePath = ``; this.userAgent = config.userAgent; @@ -51,10 +51,10 @@ export default class OAuthResource extends BungieResource { * @param {string} code The authorization code from the oauth redirect url * @param {string} [oauthClientId] The oauth client id if present * @param {string} [oauthClientSecret] The oauth client secret key if present - * @returns {Promise} + * @returns {Promise} * @memberof Traveler */ - public getAccessToken(code: string, oauthClientId?: string, oauthClientSecret?: string): Promise { + public getAccessToken(code: string, oauthClientId?: string, oauthClientSecret?: string): Promise { let form = new FormData(); form.append('client_id', oauthClientId); form.append('code', code); @@ -76,10 +76,10 @@ export default class OAuthResource extends BungieResource { json: true }; - return new Promise((resolve, reject) => { + return new Promise((resolve, reject) => { this.httpService .post('https://www.bungie.net/platform/app/oauth/token/', options) - .then((response: IOAuthResponse) => { + .then((response: OAuthResponse) => { resolve(response); }) .catch(err => { @@ -107,10 +107,10 @@ export default class OAuthResource extends BungieResource { * @param {string} refreshToken * @param {string} oauthClientId The oauth client id * @param {string} oauthClientSecret The oauth client secret key - * @returns {Promise} + * @returns {Promise} * @memberof Traveler */ - public refreshToken(refreshToken: string, oauthClientId: string, oauthClientSecret: string): Promise { + public refreshToken(refreshToken: string, oauthClientId: string, oauthClientSecret: string): Promise { let form = new FormData(); form.append('refresh_token', refreshToken); form.append('grant_type', 'refresh_token'); @@ -124,10 +124,10 @@ export default class OAuthResource extends BungieResource { json: true }; - return new Promise((resolve, reject) => { + return new Promise((resolve, reject) => { this.httpService .post('https://www.bungie.net/platform/app/oauth/token/', options) - .then((response: IOAuthResponse) => { + .then((response: OAuthResponse) => { resolve(response); }) .catch(err => { diff --git a/src/resources/UserResource.ts b/src/resources/UserResource.ts index c8ce4f8..06e225f 100644 --- a/src/resources/UserResource.ts +++ b/src/resources/UserResource.ts @@ -1,7 +1,7 @@ import BungieResource from './BungieResoure'; import HTTPService from '../HttpService'; -import { IServerResponse } from '../type-definitions/app'; -import { IUserMembershipData, BungieMembershipType } from '../type-definitions/user'; +import { ServerResponse } from '../type-definitions/app'; +import { UserMembershipData, BungieMembershipType } from '../type-definitions/user'; import { checkOauthToken } from '../util'; export default class UserResource extends BungieResource { @@ -26,16 +26,16 @@ export default class UserResource extends BungieResource { * ``` * * @param {string} oauthAccesstoken - * @returns {Promise>} + * @returns {Promise>} * @memberof UserResource */ - public getMembershipDataForCurrentUser(oauthAccesstoken: string): Promise> { + public getMembershipDataForCurrentUser(oauthAccesstoken: string): Promise> { checkOauthToken(oauthAccesstoken); - return new Promise>((resolve, reject) => { + return new Promise>((resolve, reject) => { this.httpService .get(`${this.resourcePath}/GetMembershipsForCurrentUser/`, oauthAccesstoken) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { @@ -63,20 +63,20 @@ export default class UserResource extends BungieResource { * @param {string} destinyMembershipId * @param {BungieMembershipType} membershipType * @param {string} oauthAccesstoken - * @returns {Promise>} + * @returns {Promise>} * @memberof UserResource */ public getMembershipDataById( destinyMembershipId: string, membershipType: BungieMembershipType, oauthAccesstoken: string - ): Promise> { + ): Promise> { checkOauthToken(oauthAccesstoken); - return new Promise>((resolve, reject) => { + return new Promise>((resolve, reject) => { this.httpService .get(`${this.resourcePath}/GetMembershipsById/${destinyMembershipId}/${membershipType}/`, oauthAccesstoken) - .then((response: IServerResponse) => { + .then((response: ServerResponse) => { resolve(response); }) .catch(err => { diff --git a/src/type-definitions/additions.ts b/src/type-definitions/additions.ts index 26e31a7..dbe43a3 100644 --- a/src/type-definitions/additions.ts +++ b/src/type-definitions/additions.ts @@ -1,9 +1,4 @@ -import { - DestinyActivityModeType, - DestinyStatsGroupType, - PeriodType, - DestinyComponentType -} from '../type-definitions/destiny2'; +import { DestinyActivityModeType, DestinyStatsGroupType, PeriodType, DestinyComponentType } from './destiny2'; /** * Enum for the global alert level @@ -303,7 +298,7 @@ export enum TypeDefinition { * Interface for defining an object for the Traveler class * @interface */ -export interface ITravelerConfig { +export interface TravelerConfig { apikey: string; userAgent: string; oauthClientId?: string; @@ -311,21 +306,21 @@ export interface ITravelerConfig { debug?: boolean; } -export interface IStreamInfo { +export interface StreamInfo { ChannelName: string; } -export interface IGlobalAlert { +export interface GlobalAlert { AlertKey: string; AlertHtml: string; AlerTimestamp: Date; AlertLink: string; AlertLevel: GlobalAlertLevel; AlertType: GlobalAlertType; - StreamInfo: IStreamInfo; + StreamInfo: StreamInfo; } -export interface IDictionaryResponse { +export interface DictionaryResponse { [key: string]: S; } @@ -333,7 +328,7 @@ export interface IDictionaryResponse { * Interface for defining an object for the endpoint query strings * @interface */ -export interface IQueryStringParameters { +export interface QueryStringParameters { components?: DestinyComponentType[]; modes?: DestinyActivityModeType[]; mode?: DestinyActivityModeType; @@ -352,7 +347,7 @@ export interface IQueryStringParameters { * Interface for defining an object for the OAuth response * @interface */ -export interface IOAuthResponse { +export interface OAuthResponse { access_token: string; token_type: string; expires_in: number; diff --git a/src/type-definitions/app/index.ts b/src/type-definitions/app/index.ts index ce8fa5a..30180d1 100644 --- a/src/type-definitions/app/index.ts +++ b/src/type-definitions/app/index.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. diff --git a/src/type-definitions/app/interfaces.ts b/src/type-definitions/app/interfaces.ts index 044ce6a..00c6164 100644 --- a/src/type-definitions/app/interfaces.ts +++ b/src/type-definitions/app/interfaces.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. @@ -11,39 +11,39 @@ */ import { - IDateRange + DateRange } from '../common'; import { - IUserInfoCard + UserInfoCard } from '../user/interfaces'; -export interface IApiUsage { +export interface ApiUsage { /** The date range for the data being reported. */ - readonly range: IDateRange; + readonly range: DateRange; /** Counts for on API calls made for the time range. */ - readonly apiCalls: ISeries[]; + readonly apiCalls: Series[]; /** * Instances of blocked requests or requests that crossed the warn threshold during * the time range. */ - readonly throttledRequests: ISeries[]; + readonly throttledRequests: Series[]; } -export interface ISeries { +export interface Series { /** Collection of samples with time and value. */ - readonly datapoints: IDatapoint[]; + readonly datapoints: Datapoint[]; /** Target to which to datapoints apply. */ readonly target: string; } -export interface IDatapoint { +export interface Datapoint { /** Timestamp for the related count. */ readonly time: string; /** Count associated with timestamp */ readonly count?: number; } -export interface IApplication { +export interface Application { readonly applicationType: OAuthApplicationType; /** Unique ID assigned to the application */ readonly applicationId: number; @@ -69,7 +69,7 @@ export interface IApplication { * List of team members who manage this application on Bungie.net. Will always * consist of at least the application owner. */ - readonly team: IApplicationDeveloper[]; + readonly team: ApplicationDeveloper[]; } export const enum OAuthApplicationType { @@ -109,10 +109,10 @@ export const enum ApplicationStatus { Blocked = 4 } -export interface IApplicationDeveloper { +export interface ApplicationDeveloper { readonly role: DeveloperRole; readonly apiEulaVersion: number; - readonly user: IUserInfoCard; + readonly user: UserInfoCard; } export const enum DeveloperRole { diff --git a/src/type-definitions/common.ts b/src/type-definitions/common.ts index 2fa3ab3..36a0486 100644 --- a/src/type-definitions/common.ts +++ b/src/type-definitions/common.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. @@ -10,7 +10,7 @@ * Do not edit these files manually. */ -export interface IServerResponse { +export interface ServerResponse { readonly Response: T; readonly ErrorCode: PlatformErrorCodes; readonly ThrottleSeconds: number; @@ -19,7 +19,7 @@ export interface IServerResponse { readonly MessageData: { [key: string]: string }; } -export interface IDateRange { +export interface DateRange { readonly start: string; readonly end: string; } @@ -194,6 +194,9 @@ export const enum PlatformErrorCodes { UserAcknowledgmentTableFull = 225, UserCreationDestinyMembershipRequired = 226, UserFriendsTokenNeedsRefresh = 227, + UserEmailValidationUnknown = 228, + UserEmailValidationLimit = 229, + TransactionEmailSendFailure = 230, MessagingUnknownError = 300, MessagingSelfError = 301, MessagingSendThrottle = 302, @@ -400,6 +403,7 @@ export const enum PlatformErrorCodes { ShareAlreadyShared = 706, ActivityLoggingDisabled = 707, ClanRequiresExistingDestinyAccount = 750, + ClanNameRestricted = 751, ItemAlreadyFollowed = 801, ItemNotFollowed = 802, CannotFollowSelf = 803, @@ -707,9 +711,15 @@ export const enum PlatformErrorCodes { ClanFireteamPublicCreationRestriction = 3022, ClanFireteamAlreadyJoined = 3023, ClanFireteamScheduledFireteamsRange = 3024, - ClanFireteamPublicCreationRestrictionExtended = 3025 + ClanFireteamPublicCreationRestrictionExtended = 3025, + ClanFireteamExpired = 3026 } +/** + * The types of membership the Accounts system supports. This is the external + * facing enum used in place of the internal-only Bungie.SharedDefinitions. + * MembershipType. + */ export const enum BungieMembershipType { None = 0, TigerXbox = 1, @@ -724,23 +734,23 @@ export const enum BungieMembershipType { All = -1 } -export interface IPagedQuery { +export interface PagedQuery { readonly itemsPerPage: number; readonly currentPage: number; readonly requestContinuationToken: string; } -export interface IInterpolationPoint { +export interface InterpolationPoint { readonly value: number; readonly weight: number; } -export interface IInterpolationPointFloat { +export interface InterpolationPointFloat { readonly value: number; readonly weight: number; } -export interface IHyperlinkReference { +export interface HyperlinkReference { readonly title: string; readonly url: string; } diff --git a/src/type-definitions/communitycontent/index.ts b/src/type-definitions/communitycontent/index.ts index ce8fa5a..30180d1 100644 --- a/src/type-definitions/communitycontent/index.ts +++ b/src/type-definitions/communitycontent/index.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. diff --git a/src/type-definitions/communitycontent/interfaces.ts b/src/type-definitions/communitycontent/interfaces.ts index 74adbf3..df5c6f4 100644 --- a/src/type-definitions/communitycontent/interfaces.ts +++ b/src/type-definitions/communitycontent/interfaces.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. @@ -11,14 +11,14 @@ */ import { - IPagedQuery + PagedQuery } from '../common'; -import { - IUserInfoCard -} from '../user/interfaces'; import { PartnershipType } from '../platform'; +import { + UserInfoCard +} from '../user/interfaces'; export const enum CommunityStatusSort { Viewers = 0, @@ -27,11 +27,11 @@ export const enum CommunityStatusSort { Followers = 3 } -export interface ISearchResultOfCommunityLiveStatus { - readonly results: ICommunityLiveStatus[]; +export interface SearchResultOfCommunityLiveStatus { + readonly results: CommunityLiveStatus[]; readonly totalResults: number; readonly hasMore: boolean; - readonly query: IPagedQuery; + readonly query: PagedQuery; readonly replacementContinuationToken: string; /** * If useTotalResults is true, then totalResults represents an accurate count. @@ -48,7 +48,7 @@ export interface ISearchResultOfCommunityLiveStatus { readonly useTotalResults: boolean; } -export interface ICommunityLiveStatus { +export interface CommunityLiveStatus { readonly dateStatusUpdated: string; readonly url: string; readonly partnershipIdentifier: string; @@ -57,7 +57,7 @@ export interface ICommunityLiveStatus { readonly thumbnailSmall: string; readonly thumbnailLarge: string; readonly destinyCharacterId: string; - readonly userInfo: IUserInfoCard; + readonly userInfo: UserInfoCard; readonly currentActivityHash: number; readonly dateLastPlayed: string; readonly dateStreamStarted: string; diff --git a/src/type-definitions/content/index.ts b/src/type-definitions/content/index.ts index ce8fa5a..30180d1 100644 --- a/src/type-definitions/content/index.ts +++ b/src/type-definitions/content/index.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. diff --git a/src/type-definitions/content/interfaces.ts b/src/type-definitions/content/interfaces.ts index ffd8b61..dd4577c 100644 --- a/src/type-definitions/content/interfaces.ts +++ b/src/type-definitions/content/interfaces.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. @@ -11,22 +11,22 @@ */ import { - IGeneralUser + GeneralUser } from '../user/interfaces'; import { - IPagedQuery + PagedQuery } from '../common'; -export interface IContentTypeDescription { +export interface ContentTypeDescription { readonly cType: string; readonly name: string; readonly contentDescription: string; readonly previewImage: string; readonly priority: number; readonly reminder: string; - readonly properties: IContentTypeProperty[]; - readonly tagMetadata: ITagMetadataDefinition[]; - readonly tagMetadataItems: { [key: string]: ITagMetadataItem }; + readonly properties: ContentTypeProperty[]; + readonly tagMetadata: TagMetadataDefinition[]; + readonly tagMetadataItems: { [key: string]: TagMetadataItem }; readonly usageExamples: string[]; readonly showInContentEditor: boolean; readonly typeOf: string; @@ -36,12 +36,12 @@ export interface IContentTypeDescription { readonly allowComments: boolean; readonly autoEnglishPropertyFallback: boolean; readonly bulkUploadable: boolean; - readonly previews: IContentPreview[]; + readonly previews: ContentPreview[]; readonly suppressCmsPath: boolean; - readonly propertySections: IContentTypePropertySection[]; + readonly propertySections: ContentTypePropertySection[]; } -export interface IContentTypeProperty { +export interface ContentTypeProperty { readonly name: string; readonly readableName: string; readonly value: string; @@ -63,12 +63,12 @@ export interface IContentTypeProperty { readonly visibleOn: string; readonly datatype: ContentPropertyDataTypeEnum; readonly attributes: { [key: string]: string }; - readonly childProperties: IContentTypeProperty[]; + readonly childProperties: ContentTypeProperty[]; readonly contentTypeAllowed: string; readonly bindToProperty: string; readonly boundRegex: string; readonly representationSelection: { [key: string]: string }; - readonly defaultValues: IContentTypeDefaultValue[]; + readonly defaultValues: ContentTypeDefaultValue[]; readonly isExternalAllowed: boolean; readonly propertySection: string; readonly weight: number; @@ -103,22 +103,22 @@ export const enum ContentPropertyDataTypeEnum { Color = 14 } -export interface IContentTypeDefaultValue { +export interface ContentTypeDefaultValue { readonly whenClause: string; readonly whenValue: string; readonly defaultValue: string; } -export interface ITagMetadataDefinition { +export interface TagMetadataDefinition { readonly description: string; readonly order: number; - readonly items: ITagMetadataItem[]; + readonly items: TagMetadataItem[]; readonly datatype: string; readonly name: string; readonly isRequired: boolean; } -export interface ITagMetadataItem { +export interface TagMetadataItem { readonly description: string; readonly tagText: string; readonly groups: string[]; @@ -126,7 +126,7 @@ export interface ITagMetadataItem { readonly name: string; } -export interface IContentPreview { +export interface ContentPreview { readonly name: string; readonly path: string; readonly itemInSet: boolean; @@ -135,13 +135,13 @@ export interface IContentPreview { readonly useSetId: number; } -export interface IContentTypePropertySection { +export interface ContentTypePropertySection { readonly name: string; readonly readableName: string; readonly collapsed: boolean; } -export interface IContentItemPublicContract { +export interface ContentItemPublicContract { readonly contentId: string; readonly cType: string; readonly cmsPath: string; @@ -151,7 +151,7 @@ export interface IContentItemPublicContract { readonly hasAgeGate: boolean; readonly minimumAge: number; readonly ratingImagePath: string; - readonly author: IGeneralUser; + readonly author: GeneralUser; readonly autoEnglishPropertyFallback: boolean; /** * Firehose content is really a collection of metadata and "properties", which are @@ -165,27 +165,27 @@ export interface IContentItemPublicContract { * ought to be deserialized. */ readonly properties: { [key: string]: object }; - readonly representations: IContentRepresentation[]; + readonly representations: ContentRepresentation[]; readonly tags: string[]; - readonly commentSummary: ICommentSummary; + readonly commentSummary: CommentSummary; } -export interface IContentRepresentation { +export interface ContentRepresentation { readonly name: string; readonly path: string; readonly validationString: string; } -export interface ICommentSummary { +export interface CommentSummary { readonly topicId: string; readonly commentCount: number; } -export interface ISearchResultOfContentItemPublicContract { - readonly results: IContentItemPublicContract[]; +export interface SearchResultOfContentItemPublicContract { + readonly results: ContentItemPublicContract[]; readonly totalResults: number; readonly hasMore: boolean; - readonly query: IPagedQuery; + readonly query: PagedQuery; readonly replacementContinuationToken: string; /** * If useTotalResults is true, then totalResults represents an accurate count. diff --git a/src/type-definitions/destiny2/index.ts b/src/type-definitions/destiny2/index.ts index a48e25b..fecd6d2 100644 --- a/src/type-definitions/destiny2/index.ts +++ b/src/type-definitions/destiny2/index.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. diff --git a/src/type-definitions/destiny2/interfaces.ts b/src/type-definitions/destiny2/interfaces.ts index 9955721..b2ca1c5 100644 --- a/src/type-definitions/destiny2/interfaces.ts +++ b/src/type-definitions/destiny2/interfaces.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. @@ -12,24 +12,23 @@ import { BungieMembershipType, - IDateRange, - IHyperlinkReference, - IInterpolationPoint, - IInterpolationPointFloat, - IPagedQuery, + DateRange, + HyperlinkReference, + InterpolationPoint, + InterpolationPointFloat, + PagedQuery, PlatformErrorCodes } from '../common'; import { - IUserInfoCard + UserInfoCard } from '../user/interfaces'; -export interface ISingleComponentResponse { +export interface SingleComponentResponse { readonly data: T; readonly privacy: ComponentPrivacySetting; } -//INFO: Modified by aw -export interface IDictionaryComponentResponse { +export interface DictionaryComponentResponse { readonly data: { [key: string]: T }; readonly privacy: ComponentPrivacySetting; } @@ -40,12 +39,12 @@ export interface IDictionaryComponentResponse { * and Reputation Levels. Combine this "live" data with the related * DestinyProgressionDefinition for a full picture of the Progression. */ -export interface IDestinyProgression { +export interface DestinyProgression { /** * The hash identifier of the Progression in question. Use it to look up the * DestinyProgressionDefinition in static data. * - * Mapped to IDestinyProgressionDefinition in the manifest. + * Mapped to DestinyProgressionDefinition in the manifest. */ readonly progressionHash: number; /** The amount of progress earned today for this progression. */ @@ -115,8 +114,8 @@ export interface IDestinyProgression { * DestinyCharacterProgressionComponent.progressions, so you don't have to worry * about those. */ -export interface IDestinyProgressionDefinition { - readonly displayProperties: IDestinyProgressionDisplayPropertiesDefinition; +export interface DestinyProgressionDefinition { + readonly displayProperties: DestinyProgressionDisplayPropertiesDefinition; /** * The "Scope" of the progression indicates the source of the progression's live * data. @@ -143,7 +142,7 @@ export interface IDestinyProgressionDefinition { * These and more calculations are done for you if you grab live character * progression data, such as in the DestinyCharacterProgressionComponent. */ - readonly steps: IDestinyProgressionStepDefinition[]; + readonly steps: DestinyProgressionStepDefinition[]; /** * If true, the Progression is something worth showing to users. * @@ -158,11 +157,11 @@ export interface IDestinyProgressionDefinition { * This is purely for convenience, if you're looking at a progression and want to * know if and who it's related to in terms of Faction Reputation. * - * Mapped to IDestinyFactionDefinition in the manifest. + * Mapped to DestinyFactionDefinition in the manifest. */ readonly factionHash?: number; /** The #RGB string value for the color related to this progression, if there is one. */ - readonly color: IDestinyColor; + readonly color: DestinyColor; /** * For progressions that have it, this is the rank icon we use in the Companion, * displayed above the progressions' rank value. @@ -185,7 +184,7 @@ export interface IDestinyProgressionDefinition { readonly redacted: boolean; } -export interface IDestinyProgressionDisplayPropertiesDefinition { +export interface DestinyProgressionDisplayPropertiesDefinition { /** * When progressions show your "experience" gained, that bar has units (i.e. " * Experience", "Bad Dudes Snuffed Out", whatever). This is the localized string @@ -201,11 +200,19 @@ export interface IDestinyProgressionDisplayPropertiesDefinition { * * But usually, it will be a small square image that you can use as... well, an * icon. + * + * They are currently represented as 96px x 96px images. */ readonly icon: string; readonly hasIcon: boolean; } +/** + * There are many Progressions in Destiny (think Character Level, or Reputation). + * These are the various "Scopes" of Progressions, which affect many things: * + * Where/if they are stored * How they are calculated * Where they can be used in + * other game logic + */ export const enum DestinyProgressionScope { Account = 0, Character = 1, @@ -222,7 +229,7 @@ export const enum DestinyProgressionScope { * This defines a single Step in a progression (which roughly equates to a level. * See DestinyProgressionDefinition for caveats). */ -export interface IDestinyProgressionStepDefinition { +export interface DestinyProgressionStepDefinition { /** * Very rarely, Progressions will have localized text describing the Level of the * progression. This will be that localized text, if it exists. Otherwise, the @@ -243,7 +250,7 @@ export interface IDestinyProgressionStepDefinition { */ readonly progressTotal: number; /** A listing of items rewarded as a result of reaching this level. */ - readonly rewardItems: IDestinyItemQuantity[]; + readonly rewardItems: DestinyItemQuantity[]; /** * If this progression step has a specific icon related to it, this is the icon to * show. @@ -251,6 +258,10 @@ export interface IDestinyProgressionStepDefinition { readonly icon: string; } +/** + * If progression is earned, this determines whether the progression shows visual + * effects on the character or its item - or neither. + */ export const enum DestinyProgressionStepDisplayEffect { None = 0, Character = 1, @@ -263,12 +274,12 @@ export const enum DestinyProgressionStepDisplayEffect { * which case, the quantity returned will be 1. If it's not... uh, let me know okay? * Thanks. */ -export interface IDestinyItemQuantity { +export interface DestinyItemQuantity { /** * The hash identifier for the item in question. Use it to look up the item's * DestinyInventoryItemDefinition. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly itemHash: number; /** @@ -294,13 +305,13 @@ export interface IDestinyItemQuantity { * instanced terms: but an actual instance of an item can vary widely from these * generic definitions. */ -export interface IDestinyInventoryItemDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyInventoryItemDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * If this item has a collectible related to it, this is the hash identifier of * that collectible entry. * - * Mapped to IDestinyCollectibleDefinition in the manifest. + * Mapped to DestinyCollectibleDefinition in the manifest. */ readonly collectibleHash?: number; /** @@ -329,7 +340,7 @@ export interface IDestinyInventoryItemDefinition { * background color as well, though I have not bothered to investigate what items * have it nor what purposes they serve: use it as you will. */ - readonly backgroundColor: IDestinyColor; + readonly backgroundColor: DestinyColor; /** * If we were able to acquire an in-game screenshot for the item, the path to that * screenshot will be returned here. Note that not all items have screenshots: @@ -376,13 +387,13 @@ export interface IDestinyInventoryItemDefinition { * related to the action performed when using the item. (Guess what? 99% of the * time, this action is "dismantle". Shocker) */ - readonly action: IDestinyItemActionBlockDefinition; + readonly action: DestinyItemActionBlockDefinition; /** * If this item can exist in an inventory, this block will be non-null. In practice, * every item that currently exists has one of these blocks. But note that it is * not necessarily guaranteed. */ - readonly inventory: IDestinyItemInventoryBlockDefinition; + readonly inventory: DestinyItemInventoryBlockDefinition; /** * If this item is a quest, this block will be non-null. In practice, I wish I had * called this the Quest block, but at the time it wasn't clear to me whether it @@ -390,12 +401,12 @@ export interface IDestinyInventoryItemDefinition { * about the steps in the quest, and mechanics we can use for displaying and * tracking the quest. */ - readonly setData: IDestinyItemSetBlockDefinition; + readonly setData: DestinyItemSetBlockDefinition; /** * If this item can have stats (such as a weapon, armor, or vehicle), this block * will be non-null and populated with the stats found on the item. */ - readonly stats: IDestinyItemStatBlockDefinition; + readonly stats: DestinyItemStatBlockDefinition; /** * If the item is an emblem that has a special Objective attached to it - for * instance, if the emblem tracks PVP Kills, or what-have-you. This is a bit @@ -409,18 +420,18 @@ export interface IDestinyInventoryItemDefinition { * If this item can be equipped, this block will be non-null and will be populated * with the conditions under which it can be equipped. */ - readonly equippingBlock: IDestinyEquippingBlockDefinition; + readonly equippingBlock: DestinyEquippingBlockDefinition; /** * If this item can be rendered, this block will be non-null and will be populated * with rendering information. */ - readonly translationBlock: IDestinyItemTranslationBlockDefinition; + readonly translationBlock: DestinyItemTranslationBlockDefinition; /** * If this item can be Used or Acquired to gain other items (for instance, how * Eververse Boxes can be consumed to get items from the box), this block will be * non-null and will give summary information for the items that can be acquired. */ - readonly preview: IDestinyItemPreviewBlockDefinition; + readonly preview: DestinyItemPreviewBlockDefinition; /** * If this item can have a level or stats, this block will be non-null and will be * populated with default quality (item level, "quality", and infusion) data. See @@ -428,54 +439,54 @@ export interface IDestinyInventoryItemDefinition { * ll want to be aware of how you use quality and item level on the definition * level now. */ - readonly quality: IDestinyItemQualityBlockDefinition; + readonly quality: DestinyItemQualityBlockDefinition; /** * The conceptual "Value" of an item, if any was defined. See the * DestinyItemValueBlockDefinition for more details. */ - readonly value: IDestinyItemValueBlockDefinition; + readonly value: DestinyItemValueBlockDefinition; /** * If this item has a known source, this block will be non-null and populated with * source information. Unfortunately, at this time we are not generating sources: * that is some aggressively manual work which we didn't have time for, and I'm * hoping to get back to at some point in the future. */ - readonly sourceData: IDestinyItemSourceBlockDefinition; + readonly sourceData: DestinyItemSourceBlockDefinition; /** * If this item has Objectives (extra tasks that can be accomplished related to the * item... most frequently when the item is a Quest Step and the Objectives need to * be completed to move on to the next Quest Step), this block will be non-null and * the objectives defined herein. */ - readonly objectives: IDestinyItemObjectiveBlockDefinition; + readonly objectives: DestinyItemObjectiveBlockDefinition; /** * If this item *is* a Plug, this will be non-null and the info defined herein. See * DestinyItemPlugDefinition for more information. */ - readonly plug: IDestinyItemPlugDefinition; + readonly plug: DestinyItemPlugDefinition; /** * If this item has related items in a "Gear Set", this will be non-null and the * relationships defined herein. */ - readonly gearset: IDestinyItemGearsetBlockDefinition; + readonly gearset: DestinyItemGearsetBlockDefinition; /** * If this item is a "reward sack" that can be opened to provide other items, this * will be non-null and the properties of the sack contained herein. */ - readonly sack: IDestinyItemSackBlockDefinition; + readonly sack: DestinyItemSackBlockDefinition; /** * If this item has any Sockets, this will be non-null and the individual sockets * on the item will be defined herein. */ - readonly sockets: IDestinyItemSocketBlockDefinition; + readonly sockets: DestinyItemSocketBlockDefinition; /** Summary data about the item. */ - readonly summary: IDestinyItemSummaryBlockDefinition; + readonly summary: DestinyItemSummaryBlockDefinition; /** * If the item has a Talent Grid, this will be non-null and the properties of the * grid defined herein. Note that, while many items still have talent grids, the * only ones with meaningful Nodes still on them will be Subclass/"Build" items. */ - readonly talentGrid: IDestinyItemTalentGridBlockDefinition; + readonly talentGrid: DestinyItemTalentGridBlockDefinition; /** * If the item has stats, this block will be defined. It has the "raw" investment * stats for the item. These investment stats don't take into account the ways that @@ -483,17 +494,17 @@ export interface IDestinyInventoryItemDefinition { * transformations. I have retained them for debugging purposes, but I do not know * how useful people will find them. */ - readonly investmentStats: IDestinyItemInvestmentStatDefinition[]; + readonly investmentStats: DestinyItemInvestmentStatDefinition[]; /** * If the item has any *intrinsic* Perks (Perks that it will provide regardless of * Sockets, Talent Grid, and other transitory state), they will be defined here. */ - readonly perks: IDestinyItemPerkEntryDefinition[]; + readonly perks: DestinyItemPerkEntryDefinition[]; /** * If the item has any related Lore (DestinyLoreDefinition), this will be the hash * identifier you can use to look up the lore definition. * - * Mapped to IDestinyLoreDefinition in the manifest. + * Mapped to DestinyLoreDefinition in the manifest. */ readonly loreHash?: number; /** @@ -504,14 +515,14 @@ export interface IDestinyInventoryItemDefinition { * This happens sometimes when summarizing possible rewards in a tooltip. This is * the item displayed instead, if it exists. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly summaryItemHash?: number; /** * If any animations were extracted from game content for this item, these will be * the definitions of those animations. */ - readonly animations: IDestinyAnimationReference[]; + readonly animations: DestinyAnimationReference[]; /** * BNet may forbid the execution of actions on this item via the API. If that is * occurring, allowActions will be set to false. @@ -521,7 +532,7 @@ export interface IDestinyInventoryItemDefinition { * If we added any help or informational URLs about this item, these will be those * links. */ - readonly links: IHyperlinkReference[]; + readonly links: HyperlinkReference[]; /** * The boolean will indicate to us (and you!) whether something *could* happen when * you transfer this item from the Postmaster that might be considered a " @@ -554,7 +565,7 @@ export interface IDestinyInventoryItemDefinition { * The algorithm for these is, unfortunately, volatile. If you believe you see a * miscategorized item, please let us know on the Bungie API forums. * - * Mapped to IDestinyItemCategoryDefinition in the manifest. + * Mapped to DestinyItemCategoryDefinition in the manifest. */ readonly itemCategoryHashes: number[]; /** @@ -606,7 +617,7 @@ export interface IDestinyInventoryItemDefinition { * type that you can choose from freely), this field will return all of the * possible damage types that are available to the weapon by default. * - * Mapped to IDestinyDamageTypeDefinition in the manifest. + * Mapped to DestinyDamageTypeDefinition in the manifest. */ readonly damageTypeHashes: number[]; /** @@ -641,7 +652,7 @@ export interface IDestinyInventoryItemDefinition { * I will likely regret leaving in the enumeration versions of these properties, * but for now they're very convenient. * - * Mapped to IDestinyDamageTypeDefinition in the manifest. + * Mapped to DestinyDamageTypeDefinition in the manifest. */ readonly defaultDamageTypeHash?: number; /** @@ -666,7 +677,7 @@ export interface IDestinyInventoryItemDefinition { * have their own tables in the Manifest Database - also have displayable * information. This is the base class for that display information. */ -export interface IDestinyDisplayPropertiesDefinition { +export interface DestinyDisplayPropertiesDefinition { readonly description: string; readonly name: string; /** @@ -676,14 +687,16 @@ export interface IDestinyDisplayPropertiesDefinition { * * But usually, it will be a small square image that you can use as... well, an * icon. + * + * They are currently represented as 96px x 96px images. */ readonly icon: string; readonly hasIcon: boolean; } /** Defines a */ -export interface IDestinyCollectibleDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyCollectibleDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * Indicates whether this Collectible's state is determined on a per-character or * on an account-wide basis. @@ -703,11 +716,11 @@ export interface IDestinyCollectibleDefinition { * nothing useful other than the source string for this data. */ readonly sourceHash?: number; - /** Mapped to IDestinyInventoryItemDefinition in the manifest. */ + /** Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly itemHash: number; - readonly acquisitionInfo: IDestinyCollectibleAcquisitionBlock; - readonly stateInfo: IDestinyCollectibleStateBlock; - readonly presentationInfo: IDestinyPresentationChildBlock; + readonly acquisitionInfo: DestinyCollectibleAcquisitionBlock; + readonly stateInfo: DestinyCollectibleStateBlock; + readonly presentationInfo: DestinyPresentationChildBlock; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -725,15 +738,20 @@ export interface IDestinyCollectibleDefinition { readonly redacted: boolean; } +/** + * There's a lot of places where we need to know scope on more than just a profile + * or character level. For everything else, there's this more generic sense of + * scope. + */ export const enum DestinyScope { Profile = 0, Character = 1 } -export interface IDestinyCollectibleAcquisitionBlock { - /** Mapped to IDestinyMaterialRequirementSetDefinition in the manifest. */ +export interface DestinyCollectibleAcquisitionBlock { + /** Mapped to DestinyMaterialRequirementSetDefinition in the manifest. */ readonly acquireMaterialRequirementHash?: number; - /** Mapped to IDestinyUnlockValueDefinition in the manifest. */ + /** Mapped to DestinyUnlockValueDefinition in the manifest. */ readonly acquireTimestampUnlockValueHash?: number; } @@ -744,9 +762,9 @@ export interface IDestinyCollectibleAcquisitionBlock { * A variety of other entities refer to these as gatekeepers and payments for * actions that can be performed in game. */ -export interface IDestinyMaterialRequirementSetDefinition { +export interface DestinyMaterialRequirementSetDefinition { /** The list of all materials that are required. */ - readonly materials: IDestinyMaterialRequirement[]; + readonly materials: DestinyMaterialRequirement[]; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -773,12 +791,12 @@ export interface IDestinyMaterialRequirementSetDefinition { * where a single contract class is used both in definitions *and* in live data * response contracts. I'm not sure yet whether I regret that. */ -export interface IDestinyMaterialRequirement { +export interface DestinyMaterialRequirement { /** * The hash identifier of the material required. Use it to look up the material's * DestinyInventoryItemDefinition. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly itemHash: number; /** @@ -803,7 +821,7 @@ export interface IDestinyMaterialRequirement { * data for mapped Progressions, Objectives, and other features that require * storage of variable numeric values. */ -export interface IDestinyUnlockValueDefinition { +export interface DestinyUnlockValueDefinition { /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -821,10 +839,10 @@ export interface IDestinyUnlockValueDefinition { readonly redacted: boolean; } -export interface IDestinyCollectibleStateBlock { - /** Mapped to IDestinyInventoryItemDefinition in the manifest. */ +export interface DestinyCollectibleStateBlock { + /** Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly obscuredOverrideItemHash?: number; - readonly requirements: IDestinyPresentationNodeRequirementsBlock; + readonly requirements: DestinyPresentationNodeRequirementsBlock; } /** @@ -832,7 +850,7 @@ export interface IDestinyCollectibleStateBlock { * rules of those requirements, and the message(s) to be shown if these * requirements aren't met. */ -export interface IDestinyPresentationNodeRequirementsBlock { +export interface DestinyPresentationNodeRequirementsBlock { /** * If this node is not accessible due to Entitlements (for instance, you don't own * the required game expansion), this is the message to show. @@ -840,9 +858,9 @@ export interface IDestinyPresentationNodeRequirementsBlock { readonly entitlementUnavailableMessage: string; } -export interface IDestinyPresentationChildBlock { +export interface DestinyPresentationChildBlock { readonly presentationNodeType: DestinyPresentationNodeType; - /** Mapped to IDestinyPresentationNodeDefinition in the manifest. */ + /** Mapped to DestinyPresentationNodeDefinition in the manifest. */ readonly parentPresentationNodeHashes: number[]; readonly displayStyle: DestinyPresentationDisplayStyle; } @@ -874,8 +892,8 @@ export const enum DestinyPresentationNodeType { * * We'll see if I come to regret this as well. */ -export interface IDestinyPresentationNodeDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyPresentationNodeDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** The original icon for this presentation node, before we futzed with it. */ readonly originalIcon: string; /** @@ -896,18 +914,18 @@ export interface IDestinyPresentationNodeDefinition { * If this presentation node shows a related objective (for instance, if it tracks * the progress of its children), the objective being tracked is indicated here. * - * Mapped to IDestinyObjectiveDefinition in the manifest. + * Mapped to DestinyObjectiveDefinition in the manifest. */ readonly objectiveHash?: number; /** * If this presentation node has an associated "Record" that you can accomplish for * completing its children, this is the identifier of that Record. * - * Mapped to IDestinyRecordDefinition in the manifest. + * Mapped to DestinyRecordDefinition in the manifest. */ readonly completionRecordHash?: number; /** The child entities contained by this presentation node. */ - readonly children: IDestinyPresentationNodeChildrenBlock; + readonly children: DestinyPresentationNodeChildrenBlock; /** A hint for how to display this presentation node when it's shown in a list. */ readonly displayStyle: DestinyPresentationDisplayStyle; /** @@ -919,7 +937,7 @@ export interface IDestinyPresentationNodeDefinition { * The requirements for being able to interact with this presentation node and its * children. */ - readonly requirements: IDestinyPresentationNodeRequirementsBlock; + readonly requirements: DestinyPresentationNodeRequirementsBlock; /** * If this presentation node has children, but the game doesn't let you inspect the * details of those children, that is indicated here. @@ -929,7 +947,7 @@ export interface IDestinyPresentationNodeDefinition { * A quick reference to presentation nodes that have this node as a child. ( * presentation nodes can be parented under multiple parents) * - * Mapped to IDestinyPresentationNodeDefinition in the manifest. + * Mapped to DestinyPresentationNodeDefinition in the manifest. */ readonly parentNodeHashes: number[]; /** @@ -968,13 +986,13 @@ export interface IDestinyPresentationNodeDefinition { * describing the task to be accomplished, and a lot of optional tack-on data that * can enhance the information provided about the task. */ -export interface IDestinyObjectiveDefinition { +export interface DestinyObjectiveDefinition { /** * Ideally, this should tell you what your task is. I'm not going to lie to you * though. Sometimes this doesn't have useful information at all. Which sucks, but * there's nothing either of us can do about it. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * The value that the unlock value defined in unlockValueHash must reach in order * for the objective to be considered Completed. Used in calculating progress and @@ -993,7 +1011,7 @@ export interface IDestinyObjectiveDefinition { * accomplished, if there is a location defined. Look up the * DestinyLocationDefinition for this hash for that additional location info. * - * Mapped to IDestinyLocationDefinition in the manifest. + * Mapped to DestinyLocationDefinition in the manifest. */ readonly locationHash: number; /** If true, the value is allowed to go negative. */ @@ -1026,12 +1044,12 @@ export interface IDestinyObjectiveDefinition { * If this objective enables Perks intrinsically, the conditions for that enabling * are defined here. */ - readonly perks: IDestinyObjectivePerkEntryDefinition; + readonly perks: DestinyObjectivePerkEntryDefinition; /** * If this objective enables modifications on a player's stats intrinsically, the * conditions are defined here. */ - readonly stats: IDestinyObjectiveStatEntryDefinition; + readonly stats: DestinyObjectiveStatEntryDefinition; /** * If nonzero, this is the minimum value at which the objective's progression * should be shown. Otherwise, don't show it yet. @@ -1069,6 +1087,40 @@ export interface IDestinyObjectiveDefinition { readonly redacted: boolean; } +/** + * This enumeration represents the most restrictive type of gating that is being + * performed by an entity. This is useful as a shortcut to avoid a lot of lookups + * when determining whether the gating on an Entity applies to everyone equally, or + * to their specific Profile or Character states. + * + * None = There is no gating on this item. + * + * Global = The gating on this item is based entirely on global game state. It will + * be gated the same for everyone. + * + * Clan = The gating on this item is at the Clan level. For instance, if you're + * gated by Clan level this will be the case. + * + * Profile = The gating includes Profile-specific checks, but not on the Profile's + * characters. An example of this might be when you acquire an Emblem: the Emblem + * will be available in your Kiosk for all characters in your Profile from that + * point onward. + * + * Character = The gating includes Character-specific checks, including character + * level restrictions. An example of this might be an item that you can't purchase + * from a Vendor until you reach a specific Character Level. + * + * Item = The gating includes item-specific checks. For BNet, this generally + * implies that we'll show this data only on a character level or deeper. + * + * AssumedWorstCase = The unlocks and checks being used for this calculation are of + * an unknown type and are used for unknown purposes. For instance, if some great + * person decided that an unlock value should be globally scoped, but then the game + * changes it using character-specific data in a way that BNet doesn't know about. + * Because of the open-ended potential for this to occur, many unlock checks for " + * globally" scoped unlock data may be assumed as the worst case unless it has been + * specifically whitelisted as otherwise. That sucks, but them's the breaks. + */ export const enum DestinyGatingScope { None = 0, Global = 1, @@ -1087,12 +1139,12 @@ export const enum DestinyGatingScope { * locations, and through that we can at least infer the Activity, Destination, and * Place being referred to by the Objective. */ -export interface IDestinyLocationDefinition { +export interface DestinyLocationDefinition { /** * If the location has a Vendor on it, this is the hash identifier for that Vendor. * Look them up with DestinyVendorDefinition. * - * Mapped to IDestinyVendorDefinition in the manifest. + * Mapped to DestinyVendorDefinition in the manifest. */ readonly vendorHash: number; /** @@ -1100,7 +1152,7 @@ export interface IDestinyLocationDefinition { * s current state. This is a list of those potential spots, and the data we can * use at runtime to determine which one of the spots is the currently valid one. */ - readonly locationReleases: IDestinyLocationReleaseDefinition[]; + readonly locationReleases: DestinyLocationReleaseDefinition[]; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -1157,8 +1209,8 @@ export interface IDestinyLocationDefinition { * understandably complex. You will want to combine this data with live Vendor * information from the API when it is available. */ -export interface IDestinyVendorDefinition { - readonly displayProperties: IDestinyVendorDisplayPropertiesDefinition; +export interface DestinyVendorDefinition { + readonly displayProperties: DestinyVendorDisplayPropertiesDefinition; /** * If the vendor has a custom localized string describing the "buy" action, that is * returned here. @@ -1176,7 +1228,7 @@ export interface IDestinyVendorDefinition { * Apparently this is usually a related currency, like a reputation token. But it * need not be restricted to that. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly displayItemHash: number; /** If this is true, you aren't allowed to buy whatever the vendor is selling. */ @@ -1191,7 +1243,7 @@ export interface IDestinyVendorDefinition { * and details to place on the screen, such as the faction's Progression status ( * aka "Reputation"). * - * Mapped to IDestinyFactionDefinition in the manifest. + * Mapped to DestinyFactionDefinition in the manifest. */ readonly factionHash: number; /** @@ -1222,7 +1274,7 @@ export interface IDestinyVendorDefinition { * this will be the list of those date ranges. Sadly, we're not able to predict * this very frequently, so this will often be useless data. */ - readonly unlockRanges: IDateRange[]; + readonly unlockRanges: DateRange[]; /** * The internal identifier for the Vendor. A holdover from the old days of Vendors, * but we don't have time to refactor it away. @@ -1254,7 +1306,7 @@ export interface IDestinyVendorDefinition { * exist. But theoretically a Vendor could let you interact with it by performing * actions. We'll see what these end up looking like if they ever get used. */ - readonly actions: IDestinyVendorActionDefinition[]; + readonly actions: DestinyVendorActionDefinition[]; /** * These are the headers for sections of items that the vendor is selling. When you * see items organized by category in the header, it is these categories that it is @@ -1267,12 +1319,12 @@ export interface IDestinyVendorDefinition { * These are the categories post-concatenation, if the vendor had concatenation * applied. If you want the pre-aggregated category data, use originalCategories. */ - readonly categories: IDestinyVendorCategoryEntryDefinition[]; + readonly categories: DestinyVendorCategoryEntryDefinition[]; /** * See the categories property for a description of categories and why * originalCategories exists. */ - readonly originalCategories: IDestinyVendorCategoryEntryDefinition[]; + readonly originalCategories: DestinyVendorCategoryEntryDefinition[]; /** * Display Categories are different from "categories" in that these are * specifically for visual grouping and display of categories in Vendor UI. @@ -1281,19 +1333,19 @@ export interface IDestinyVendorDefinition { * categorized entirely separately from "Display Categories", there need be and * often will be no meaningful relationship between the two. */ - readonly displayCategories: IDestinyDisplayCategoryDefinition[]; + readonly displayCategories: DestinyDisplayCategoryDefinition[]; /** * In addition to selling items, vendors can have "interactions": UI where you " * talk" with the vendor and they offer you a reward, some item, or merely * acknowledge via dialog that you did something cool. */ - readonly interactions: IDestinyVendorInteractionDefinition[]; + readonly interactions: DestinyVendorInteractionDefinition[]; /** * If the vendor shows you items from your own inventory - such as the Vault vendor * does - this data describes the UI around showing those inventory buckets and * which ones get shown. */ - readonly inventoryFlyouts: IDestinyVendorInventoryFlyoutDefinition[]; + readonly inventoryFlyouts: DestinyVendorInventoryFlyoutDefinition[]; /** * If the vendor sells items (or merely has a list of items to show like the "Sack" * vendors do), this is the list of those items that the vendor can sell. From this @@ -1304,18 +1356,18 @@ export interface IDestinyVendorDefinition { * stops a vendor from selling you some specific weapon but using two different * currencies, or the same weapon at multiple "item levels". */ - readonly itemList: IDestinyVendorItemDefinition[]; + readonly itemList: DestinyVendorItemDefinition[]; /** * BNet doesn't use this data yet, but it appears to be an optional list of flavor * text about services that the Vendor can provide. */ - readonly services: IDestinyVendorServiceDefinition[]; + readonly services: DestinyVendorServiceDefinition[]; /** * If the Vendor is actually a vehicle for the transferring of items (like the * Vault and Postmaster vendors), this defines the list of source->destination * buckets for transferring. */ - readonly acceptedItems: IDestinyVendorAcceptedItemDefinition[]; + readonly acceptedItems: DestinyVendorAcceptedItemDefinition[]; /** * As many of you know, Vendor data has historically been pretty brutal on the BNet * servers. In an effort to reduce this workload, only Vendors with this flag set @@ -1330,13 +1382,13 @@ export interface IDestinyVendorDefinition { * account state. This is the list of possible locations for the vendor, along with * conditions we use to determine which one is currently active. */ - readonly locations: IDestinyVendorLocationDefinition[]; + readonly locations: DestinyVendorLocationDefinition[]; /** * A vendor can be a part of 0 or 1 "groups" at a time: a group being a collection * of Vendors related by either location or function/purpose. It's used for our our * Companion Vendor UI. Only one of these can be active for a Vendor at a time. */ - readonly groups: IDestinyVendorGroupReference[]; + readonly groups: DestinyVendorGroupReference[]; /** * Some items don't make sense to return in the API, for example because they * represent an action to be performed rather than an item being sold. I'd rather @@ -1360,7 +1412,7 @@ export interface IDestinyVendorDefinition { readonly redacted: boolean; } -export interface IDestinyVendorDisplayPropertiesDefinition { +export interface DestinyVendorDisplayPropertiesDefinition { /** * I regret calling this a "large icon". It's more like a medium-sized image with a * picture of the vendor's mug on it, trying their best to look cool. Not what one @@ -1381,7 +1433,7 @@ export interface IDestinyVendorDisplayPropertiesDefinition { * vendor and the designers wanted to show that currency when you interact with the * vendor. */ - readonly requirementsDisplay: IDestinyVendorRequirementDisplayEntryDefinition[]; + readonly requirementsDisplay: DestinyVendorRequirementDisplayEntryDefinition[]; /** This is the icon used in parts of the game UI such as the vendor's waypoint. */ readonly smallTransparentIcon: string; /** This is the icon used in the map overview, when the vendor is located on the map. */ @@ -1400,6 +1452,8 @@ export interface IDestinyVendorDisplayPropertiesDefinition { * * But usually, it will be a small square image that you can use as... well, an * icon. + * + * They are currently represented as 96px x 96px images. */ readonly icon: string; readonly hasIcon: boolean; @@ -1409,7 +1463,7 @@ export interface IDestinyVendorDisplayPropertiesDefinition { * The localized properties of the requirementsDisplay, allowing information about * the requirement or item being featured to be seen. */ -export interface IDestinyVendorRequirementDisplayEntryDefinition { +export interface DestinyVendorRequirementDisplayEntryDefinition { readonly icon: string; readonly name: string; readonly source: string; @@ -1427,13 +1481,13 @@ export interface IDestinyVendorRequirementDisplayEntryDefinition { * DestinyVendorDefinition.factionHash defines to this relationship), but Dead * Orbit could theoretically exist without the Vendor that provides rewards. */ -export interface IDestinyFactionDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyFactionDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * The hash identifier for the DestinyProgressionDefinition that indicates the * character's relationship with this faction in terms of experience and levels. * - * Mapped to IDestinyProgressionDefinition in the manifest. + * Mapped to DestinyProgressionDefinition in the manifest. */ readonly progressionHash: number; /** The faction token item hashes, and their respective progression values. */ @@ -1441,20 +1495,20 @@ export interface IDestinyFactionDefinition { /** * The faction reward item hash, usually an engram. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly rewardItemHash: number; /** * The faction reward vendor hash, used for faction engram previews. * - * Mapped to IDestinyVendorDefinition in the manifest. + * Mapped to DestinyVendorDefinition in the manifest. */ readonly rewardVendorHash: number; /** * List of vendors that are associated with this faction. The last vendor that * passes the unlock flag checks is the one that should be shown. */ - readonly vendors: IDestinyFactionVendorDefinition[]; + readonly vendors: DestinyFactionVendorDefinition[]; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -1478,18 +1532,18 @@ export interface IDestinyFactionDefinition { * A single faction may contain multiple vendors, or the same vendor available at * two different locations. */ -export interface IDestinyFactionVendorDefinition { +export interface DestinyFactionVendorDefinition { /** * The faction vendor hash. * - * Mapped to IDestinyVendorDefinition in the manifest. + * Mapped to DestinyVendorDefinition in the manifest. */ readonly vendorHash: number; /** * The hash identifier for a Destination at which this vendor may be located. Each * destination where a Vendor may exist will only ever have a single entry. * - * Mapped to IDestinyDestinationDefinition in the manifest. + * Mapped to DestinyDestinationDefinition in the manifest. */ readonly destinationHash: number; /** @@ -1507,20 +1561,20 @@ export interface IDestinyFactionVendorDefinition { * a Place might be Earth where a Destination might be Bellevue, Washington. ( * Please, pick a more interesting destination if you come to visit Earth). */ -export interface IDestinyDestinationDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyDestinationDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * The place that "owns" this Destination. Use this hash to look up the * DestinyPlaceDefinition. * - * Mapped to IDestinyPlaceDefinition in the manifest. + * Mapped to DestinyPlaceDefinition in the manifest. */ readonly placeHash: number; /** * If this Destination has a default Free-Roam activity, this is the hash for that * Activity. Use it to look up the DestinyActivityDefintion. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly defaultFreeroamActivityHash: number; /** @@ -1530,7 +1584,7 @@ export interface IDestinyDestinationDefinition { * different variants on a Map if the Destination is changing on a macro level * based on game state. */ - readonly activityGraphEntries: IDestinyActivityGraphListEntryDefinition[]; + readonly activityGraphEntries: DestinyActivityGraphListEntryDefinition[]; /** * A Destination may have many "Bubbles" zones with human readable properties. * @@ -1542,7 +1596,7 @@ export interface IDestinyDestinationDefinition { * * DEPRECATED - Just use bubbles, it now has this data. */ - readonly bubbleSettings: IDestinyDestinationBubbleSettingDefinition[]; + readonly bubbleSettings: DestinyDestinationBubbleSettingDefinition[]; /** * This provides the unique identifiers for every bubble in the destination (only * guaranteed unique within the destination), and any intrinsic properties of the @@ -1551,7 +1605,7 @@ export interface IDestinyDestinationDefinition { * bubbleSettings and bubbles both have the identical number of entries, and you * should match up their indexes to provide matching bubble and bubbleSettings data. */ - readonly bubbles: IDestinyBubbleDefinition[]; + readonly bubbles: DestinyBubbleDefinition[]; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -1576,8 +1630,8 @@ export interface IDestinyDestinationDefinition { * * Places are more on the planetary scale, like "Earth" and "Your Mom." */ -export interface IDestinyPlaceDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyPlaceDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -1620,24 +1674,24 @@ export interface IDestinyPlaceDefinition { * as time goes on, but for now we're going to have to deal with the limitations. * See DestinyActivityTypeDefinition for more information. */ -export interface IDestinyActivityDefinition { +export interface DestinyActivityDefinition { /** * The title, subtitle, and icon for the activity. We do a little post-processing * on this to try and account for Activities where the designers have left this * data too minimal to determine what activity is actually being played. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * The unadulterated form of the display properties, as they ought to be shown in * the Director (if the activity appears in the director). */ - readonly originalDisplayProperties: IDestinyDisplayPropertiesDefinition; + readonly originalDisplayProperties: DestinyDisplayPropertiesDefinition; /** * The title, subtitle, and icon for the activity as determined by Selection Screen * data, if there is any for this activity. There won't be data in this field if * the activity is never shown in a selection/options screen. */ - readonly selectionScreenDisplayProperties: IDestinyDisplayPropertiesDefinition; + readonly selectionScreenDisplayProperties: DestinyDisplayPropertiesDefinition; /** * If the activity has an icon associated with a specific release (such as a DLC), * this is the path to that release's icon. @@ -1659,7 +1713,7 @@ export interface IDestinyActivityDefinition { * Place". For instance, if the "Place" is Earth, the "Destination" would be a * specific city or region on Earth. * - * Mapped to IDestinyDestinationDefinition in the manifest. + * Mapped to DestinyDestinationDefinition in the manifest. */ readonly destinationHash: number; /** @@ -1669,7 +1723,7 @@ export interface IDestinyActivityDefinition { * the "Place" is Earth, the "Destination" would be a specific city or region on * Earth. * - * Mapped to IDestinyPlaceDefinition in the manifest. + * Mapped to DestinyPlaceDefinition in the manifest. */ readonly placeHash: number; /** @@ -1679,7 +1733,7 @@ export interface IDestinyActivityDefinition { * Types. You'll have to use your knowledge of the Activity Mode being played to * get more specific information about what the user is playing. * - * Mapped to IDestinyActivityTypeDefinition in the manifest. + * Mapped to DestinyActivityTypeDefinition in the manifest. */ readonly activityTypeHash: number; /** The difficulty tier of the activity. */ @@ -1702,14 +1756,14 @@ export interface IDestinyActivityDefinition { * game doesn't even know what you'll earn specifically until you roll for it at * the end) */ - readonly rewards: IDestinyActivityRewardDefinition[]; + readonly rewards: DestinyActivityRewardDefinition[]; /** * Activities can have Modifiers, as defined in DestinyActivityModifierDefinition. * These are references to the modifiers that *can* be applied to that activity, * along with data that we use to determine if that modifier is actually active at * any given point in time. */ - readonly modifiers: IDestinyActivityModifierReferenceDefinition[]; + readonly modifiers: DestinyActivityModifierReferenceDefinition[]; /** * If True, this Activity is actually a Playlist that refers to multiple possible * specific Activities and Activity Modes. For instance, a Crucible Playlist may @@ -1728,41 +1782,41 @@ export interface IDestinyActivityDefinition { * the Destiny 2 ecosystem. I have it in mind to centralize these in a future * revision of the API, but we are out of time. */ - readonly challenges: IDestinyActivityChallengeDefinition[]; + readonly challenges: DestinyActivityChallengeDefinition[]; /** * If there are status strings related to the activity and based on internal state * of the game, account, or character, then this will be the definition of those * strings and the states needed in order for the strings to be shown. */ - readonly optionalUnlockStrings: IDestinyActivityUnlockStringDefinition[]; + readonly optionalUnlockStrings: DestinyActivityUnlockStringDefinition[]; /** * Represents all of the possible activities that could be played in the Playlist, * along with information that we can use to determine if they are active at the * present time. */ - readonly playlistItems: IDestinyActivityPlaylistItemDefinition[]; + readonly playlistItems: DestinyActivityPlaylistItemDefinition[]; /** * Unfortunately, in practice this is almost never populated. In theory, this is * supposed to tell which Activity Graph to show if you bring up the director while * in this activity. */ - readonly activityGraphList: IDestinyActivityGraphListEntryDefinition[]; + readonly activityGraphList: DestinyActivityGraphListEntryDefinition[]; /** * This block of data provides information about the Activity's matchmaking * attributes: how many people can join and such. */ - readonly matchmaking: IDestinyActivityMatchmakingBlockDefinition; + readonly matchmaking: DestinyActivityMatchmakingBlockDefinition; /** * This block of data, if it exists, provides information about the guided game * experience and restrictions for this activity. If it doesn't exist, the game is * not able to be played as a guided game. */ - readonly guidedGame: IDestinyActivityGuidedBlockDefinition; + readonly guidedGame: DestinyActivityGuidedBlockDefinition; /** * If this activity had an activity mode directly defined on it, this will be the * hash of that mode. * - * Mapped to IDestinyActivityModeDefinition in the manifest. + * Mapped to DestinyActivityModeDefinition in the manifest. */ readonly directActivityModeHash?: number; /** @@ -1776,13 +1830,13 @@ export interface IDestinyActivityDefinition { * one through activity-associated data such as Milestones that have activity info * on them. */ - readonly loadouts: IDestinyActivityLoadoutRequirementSet[]; + readonly loadouts: DestinyActivityLoadoutRequirementSet[]; /** * The hash identifiers for Activity Modes relevant to this activity. Note that if * this is a playlist, the specific playlist entry chosen will determine the actual * activity modes that end up being relevant. * - * Mapped to IDestinyActivityModeDefinition in the manifest. + * Mapped to DestinyActivityModeDefinition in the manifest. */ readonly activityModeHashes: number[]; /** @@ -1796,12 +1850,12 @@ export interface IDestinyActivityDefinition { * The list of phases or points of entry into an activity, along with information * we can use to determine their gating and availability. */ - readonly insertionPoints: IDestinyActivityInsertionPointDefinition[]; + readonly insertionPoints: DestinyActivityInsertionPointDefinition[]; /** * A list of location mappings that are affected by this activity. Pulled out of * DestinyLocationDefinitions for our/your lookup convenience. */ - readonly activityLocationMappings: IDestinyEnvironmentLocationMapping[]; + readonly activityLocationMappings: DestinyEnvironmentLocationMapping[]; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -1837,8 +1891,8 @@ export interface IDestinyActivityDefinition { * indicator of activity category. But for the time being, it is still referred to * in many places across our codebase. */ -export interface IDestinyActivityTypeDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyActivityTypeDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -1860,7 +1914,7 @@ export interface IDestinyActivityTypeDefinition { * Activities can refer to one or more sets of tooltip-friendly reward data. These * are the definitions for those tooltip friendly rewards. */ -export interface IDestinyActivityRewardDefinition { +export interface DestinyActivityRewardDefinition { /** The header for the reward set, if any. */ readonly rewardText: string; /** @@ -1878,7 +1932,7 @@ export interface IDestinyActivityRewardDefinition { * your profile-level inventory through the BNet API! Who said reading * documentation is a waste of time? */ - readonly rewardItems: IDestinyItemQuantity[]; + readonly rewardItems: DestinyItemQuantity[]; } /** @@ -1887,12 +1941,12 @@ export interface IDestinyActivityRewardDefinition { * * This defines some */ -export interface IDestinyActivityModifierReferenceDefinition { +export interface DestinyActivityModifierReferenceDefinition { /** * The hash identifier for the DestinyActivityModifierDefinition referenced by this * activity. * - * Mapped to IDestinyActivityModifierDefinition in the manifest. + * Mapped to DestinyActivityModifierDefinition in the manifest. */ readonly activityModifierHash: number; } @@ -1901,8 +1955,8 @@ export interface IDestinyActivityModifierReferenceDefinition { * Modifiers - in Destiny 1, these were referred to as "Skulls" - are changes that * can be applied to an Activity. */ -export interface IDestinyActivityModifierDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyActivityModifierDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -1921,12 +1975,12 @@ export interface IDestinyActivityModifierDefinition { } /** Represents a reference to a Challenge, which for now is just an Objective. */ -export interface IDestinyActivityChallengeDefinition { +export interface DestinyActivityChallengeDefinition { /** * The hash for the Objective that matches this challenge. Use it to look up the * DestinyObjectiveDefinition. * - * Mapped to IDestinyObjectiveDefinition in the manifest. + * Mapped to DestinyObjectiveDefinition in the manifest. */ readonly objectiveHash: number; /** @@ -1936,7 +1990,7 @@ export interface IDestinyActivityChallengeDefinition { * * If the quantity is 0, don't show the quantity. */ - readonly dummyRewards: IDestinyItemQuantity[]; + readonly dummyRewards: DestinyItemQuantity[]; } /** @@ -1945,7 +1999,7 @@ export interface IDestinyActivityChallengeDefinition { * Internally we combine this information with server state to determine which * strings should be shown. */ -export interface IDestinyActivityUnlockStringDefinition { +export interface DestinyActivityUnlockStringDefinition { /** The string to be displayed if the conditions are met. */ readonly displayString: string; } @@ -1955,19 +2009,19 @@ export interface IDestinyActivityUnlockStringDefinition { * the playlist: a single possible combination of Activity and Activity Mode that * can be chosen. */ -export interface IDestinyActivityPlaylistItemDefinition { +export interface DestinyActivityPlaylistItemDefinition { /** * The hash identifier of the Activity that can be played. Use it to look up the * DestinyActivityDefinition. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly activityHash: number; /** * If this playlist entry had an activity mode directly defined on it, this will be * the hash of that mode. * - * Mapped to IDestinyActivityModeDefinition in the manifest. + * Mapped to DestinyActivityModeDefinition in the manifest. */ readonly directActivityModeHash?: number; /** @@ -1978,7 +2032,7 @@ export interface IDestinyActivityPlaylistItemDefinition { /** * The hash identifiers for Activity Modes relevant to this entry. * - * Mapped to IDestinyActivityModeDefinition in the manifest. + * Mapped to DestinyActivityModeDefinition in the manifest. */ readonly activityModeHashes: number[]; /** @@ -1999,8 +2053,8 @@ export interface IDestinyActivityPlaylistItemDefinition { * for - for example - "AllPvP", you will get any PVP activities that the user has * played, regardless of what specific PVP mode was being played. */ -export interface IDestinyActivityModeDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyActivityModeDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * If this activity mode has a related PGCR image, this will be the path to said * image. @@ -2074,6 +2128,11 @@ export interface IDestinyActivityModeDefinition { readonly redacted: boolean; } +/** + * For historical reasons, this list will have both D1 and D2-relevant Activity + * Modes in it. Please don't take this to mean that some D1-only feature is coming + * back! + */ export const enum DestinyActivityModeType { None = 0, Story = 2, @@ -2139,9 +2198,18 @@ export const enum DestinyActivityModeType { Breakthrough = 65, BlackArmoryRun = 66, Salvage = 67, - IronBannerSalvage = 68 -} - + IronBannerSalvage = 68, + PvPCompetitive = 69, + PvPQuickplay = 70, + ClashQuickplay = 71, + ClashCompetitive = 72, + ControlQuickplay = 73, + ControlCompetitive = 74, + GambitPrime = 75, + Reckoning = 76 +} + +/** Activity Modes are grouped into a few possible broad categories. */ export const enum DestinyActivityModeCategory { /** Activities that are neither PVP nor PVE, such as social activities. */ None = 0, @@ -2163,12 +2231,12 @@ export const enum DestinyActivityModeCategory { * This contract defines the graph referred to and the gating for when it is * relevant. */ -export interface IDestinyActivityGraphListEntryDefinition { +export interface DestinyActivityGraphListEntryDefinition { /** * The hash identifier of the DestinyActivityGraphDefinition that should be shown * when opening the director. * - * Mapped to IDestinyActivityGraphDefinition in the manifest. + * Mapped to DestinyActivityGraphDefinition in the manifest. */ readonly activityGraphHash: number; } @@ -2192,34 +2260,34 @@ export interface IDestinyActivityGraphListEntryDefinition { * unmaintainable as the game's content changed. So don't bet the farm on us * providing that content in this definition. */ -export interface IDestinyActivityGraphDefinition { +export interface DestinyActivityGraphDefinition { /** * These represent the visual "nodes" on the map's view. These are the activities * you can click on in the map. */ - readonly nodes: IDestinyActivityGraphNodeDefinition[]; + readonly nodes: DestinyActivityGraphNodeDefinition[]; /** Represents one-off/special UI elements that appear on the map. */ - readonly artElements: IDestinyActivityGraphArtElementDefinition[]; + readonly artElements: DestinyActivityGraphArtElementDefinition[]; /** * Represents connections between graph nodes. However, it lacks context that we'd * need to make good use of it. */ - readonly connections: IDestinyActivityGraphConnectionDefinition[]; + readonly connections: DestinyActivityGraphConnectionDefinition[]; /** * Objectives can display on maps, and this is supposedly metadata for that. I have * not had the time to analyze the details of what is useful within however: we * could be missing important data to make this work. Expect this property to be * expanded on later if possible. */ - readonly displayObjectives: IDestinyActivityGraphDisplayObjectiveDefinition[]; + readonly displayObjectives: DestinyActivityGraphDisplayObjectiveDefinition[]; /** * Progressions can also display on maps, but similarly to displayObjectives we * appear to lack some required information and context right now. We will have to * look into it later and add more data if possible. */ - readonly displayProgressions: IDestinyActivityGraphDisplayProgressionDefinition[]; + readonly displayProgressions: DestinyActivityGraphDisplayProgressionDefinition[]; /** Represents links between this Activity Graph and other ones. */ - readonly linkedGraphs: IDestinyLinkedGraphDefinition[]; + readonly linkedGraphs: DestinyLinkedGraphDefinition[]; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -2244,7 +2312,7 @@ export interface IDestinyActivityGraphDefinition { * unless overrideDisplay information is provided, will also determine the tooltip * and other UI related to the node) */ -export interface IDestinyActivityGraphNodeDefinition { +export interface DestinyActivityGraphNodeDefinition { /** * An identifier for the Activity Graph Node, only guaranteed to be unique within * its parent Activity Graph. @@ -2254,9 +2322,9 @@ export interface IDestinyActivityGraphNodeDefinition { * The node *may* have display properties that override the active Activity's * display properties. */ - readonly overrideDisplay: IDestinyDisplayPropertiesDefinition; + readonly overrideDisplay: DestinyDisplayPropertiesDefinition; /** The position on the map for this node. */ - readonly position: IDestinyPositionDefinition; + readonly position: DestinyPositionDefinition; /** * The node may have various visual accents placed on it, or styles applied. These * are the list of possible styles that the Node can have. The game iterates @@ -2264,22 +2332,22 @@ export interface IDestinyActivityGraphNodeDefinition { * character/account state in order to show that style, and then renders the node * in that style. */ - readonly featuringStates: IDestinyActivityGraphNodeFeaturingStateDefinition[]; + readonly featuringStates: DestinyActivityGraphNodeFeaturingStateDefinition[]; /** * The node may have various possible activities that could be active for it, * however only one may be active at a time. See the * DestinyActivityGraphNodeActivityDefinition for details. */ - readonly activities: IDestinyActivityGraphNodeActivityDefinition[]; + readonly activities: DestinyActivityGraphNodeActivityDefinition[]; /** * Represents possible states that the graph node can be in. These are combined * with some checking that happens in the game client and server to determine which * state is actually active at any given time. */ - readonly states: IDestinyActivityGraphNodeStateEntry[]; + readonly states: DestinyActivityGraphNodeStateEntry[]; } -export interface IDestinyPositionDefinition { +export interface DestinyPositionDefinition { readonly x: number; readonly y: number; readonly z: number; @@ -2290,7 +2358,7 @@ export interface IDestinyPositionDefinition { * state ("highlight type") that a node can be in, and the unlock expression * condition to determine whether it should be set. */ -export interface IDestinyActivityGraphNodeFeaturingStateDefinition { +export interface DestinyActivityGraphNodeFeaturingStateDefinition { /** * The node can be highlighted in a variety of ways - the game iterates through * these and finds the first FeaturingState that is valid at the present moment @@ -2300,6 +2368,13 @@ export interface IDestinyActivityGraphNodeFeaturingStateDefinition { readonly highlightType: ActivityGraphNodeHighlightType; } +/** + * The various known UI styles in which an item can be highlighted. It'll be up to + * you to determine what you want to show based on this highlighting, BNet doesn't + * have any assets that correspond to these states. And yeah, RiseOfIron and Comet + * have their own special highlight states. Don't ask me, I can't imagine they're + * still used. + */ export const enum ActivityGraphNodeHighlightType { None = 0, Normal = 1, @@ -2317,7 +2392,7 @@ export const enum ActivityGraphNodeHighlightType { * the weekly Crucible Playlist. There are multiple possible playlists, but only * one is active for the week. */ -export interface IDestinyActivityGraphNodeActivityDefinition { +export interface DestinyActivityGraphNodeActivityDefinition { /** * An identifier for this node activity. It is only guaranteed to be unique within * the Activity Graph. @@ -2328,7 +2403,7 @@ export interface IDestinyActivityGraphNodeActivityDefinition { * all activity-related information displayed on the node if it is active (the text * shown in the tooltip etc) * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly activityHash: number; } @@ -2338,10 +2413,11 @@ export interface IDestinyActivityGraphNodeActivityDefinition { * going on in the game, graph nodes could be shown in different ways or even * excluded from view entirely. */ -export interface IDestinyActivityGraphNodeStateEntry { +export interface DestinyActivityGraphNodeStateEntry { readonly state: DestinyGraphNodeState; } +/** Represents a potential state of an Activity Graph node. */ export const enum DestinyGraphNodeState { Hidden = 0, Visible = 1, @@ -2356,9 +2432,9 @@ export const enum DestinyGraphNodeState { * overlays, so this info exists as a placeholder for when such a pipeline exists ( * if it ever will) */ -export interface IDestinyActivityGraphArtElementDefinition { +export interface DestinyActivityGraphArtElementDefinition { /** The position on the map of the art element. */ - readonly position: IDestinyPositionDefinition; + readonly position: DestinyPositionDefinition; } /** @@ -2366,7 +2442,7 @@ export interface IDestinyActivityGraphArtElementDefinition { * about which nodes to link. It appears to lack more detailed information, such as * the path for that linking. */ -export interface IDestinyActivityGraphConnectionDefinition { +export interface DestinyActivityGraphConnectionDefinition { readonly sourceNodeHash: number; readonly destNodeHash: number; } @@ -2375,7 +2451,7 @@ export interface IDestinyActivityGraphConnectionDefinition { * When a Graph needs to show active Objectives, this defines those objectives as * well as an identifier. */ -export interface IDestinyActivityGraphDisplayObjectiveDefinition { +export interface DestinyActivityGraphDisplayObjectiveDefinition { /** * $NOTE $amola 2017-01-19 This field is apparently something that CUI uses to * manually wire up objectives to display info. I am unsure how it works. @@ -2384,7 +2460,7 @@ export interface IDestinyActivityGraphDisplayObjectiveDefinition { /** * The objective being shown on the map. * - * Mapped to IDestinyObjectiveDefinition in the manifest. + * Mapped to DestinyObjectiveDefinition in the manifest. */ readonly objectiveHash: number; } @@ -2393,7 +2469,7 @@ export interface IDestinyActivityGraphDisplayObjectiveDefinition { * When a Graph needs to show active Progressions, this defines those objectives as * well as an identifier. */ -export interface IDestinyActivityGraphDisplayProgressionDefinition { +export interface DestinyActivityGraphDisplayProgressionDefinition { readonly id: number; readonly progressionHash: number; } @@ -2402,12 +2478,12 @@ export interface IDestinyActivityGraphDisplayProgressionDefinition { * This describes links between the current graph and others, as well as when that * link is relevant. */ -export interface IDestinyLinkedGraphDefinition { +export interface DestinyLinkedGraphDefinition { readonly description: string; readonly name: string; - readonly unlockExpression: IDestinyUnlockExpressionDefinition; + readonly unlockExpression: DestinyUnlockExpressionDefinition; readonly linkedGraphId: number; - readonly linkedGraphs: IDestinyLinkedGraphEntryDefinition[]; + readonly linkedGraphs: DestinyLinkedGraphEntryDefinition[]; readonly overview: string; } @@ -2420,7 +2496,7 @@ export interface IDestinyLinkedGraphDefinition { * Use UnlockExpressionParser to evaluate expressions using an IUnlockContext * parsed from Babel. */ -export interface IDestinyUnlockExpressionDefinition { +export interface DestinyUnlockExpressionDefinition { /** * A shortcut for determining the most restrictive gating that this expression * performs. See the DestinyGatingScope enum's documentation for more details. @@ -2428,12 +2504,12 @@ export interface IDestinyUnlockExpressionDefinition { readonly scope: DestinyGatingScope; } -export interface IDestinyLinkedGraphEntryDefinition { +export interface DestinyLinkedGraphEntryDefinition { readonly activityGraphHash: number; } /** Information about matchmaking and party size for the activity. */ -export interface IDestinyActivityMatchmakingBlockDefinition { +export interface DestinyActivityMatchmakingBlockDefinition { /** * If TRUE, the activity is matchmade. Otherwise, it requires explicit forming of a * party. @@ -2450,7 +2526,7 @@ export interface IDestinyActivityMatchmakingBlockDefinition { } /** Guided Game information for this activity. */ -export interface IDestinyActivityGuidedBlockDefinition { +export interface DestinyActivityGuidedBlockDefinition { /** The maximum amount of people that can be in the waiting lobby. */ readonly guidedMaxLobbySize: number; /** The minimum amount of people that can be in the waiting lobby. */ @@ -2463,18 +2539,18 @@ export interface IDestinyActivityGuidedBlockDefinition { readonly guidedDisbandCount: number; } -export interface IDestinyActivityLoadoutRequirementSet { +export interface DestinyActivityLoadoutRequirementSet { /** * The set of requirements that will be applied on the activity if this requirement * set is active. */ - readonly requirements: IDestinyActivityLoadoutRequirement[]; + readonly requirements: DestinyActivityLoadoutRequirement[]; } -export interface IDestinyActivityLoadoutRequirement { - /** Mapped to IDestinyEquipmentSlotDefinition in the manifest. */ +export interface DestinyActivityLoadoutRequirement { + /** Mapped to DestinyEquipmentSlotDefinition in the manifest. */ readonly equipmentSlotHash: number; - /** Mapped to IDestinyInventoryItemDefinition in the manifest. */ + /** Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly allowedEquippedItemHashes: number[]; readonly allowedWeaponSubTypes: DestinyItemSubType[]; } @@ -2493,8 +2569,8 @@ export interface IDestinyActivityLoadoutRequirement { * An Equipment Slot must have a related Inventory Bucket, but not all inventory * buckets must have Equipment Slots. */ -export interface IDestinyEquipmentSlotDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyEquipmentSlotDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * These technically point to "Equipment Category Definitions". But don't get * excited. There's nothing of significant value in those definitions, so I didn't @@ -2506,7 +2582,7 @@ export interface IDestinyEquipmentSlotDefinition { /** * The inventory bucket that owns this equipment slot. * - * Mapped to IDestinyInventoryBucketDefinition in the manifest. + * Mapped to DestinyInventoryBucketDefinition in the manifest. */ readonly bucketTypeHash: number; /** @@ -2516,7 +2592,7 @@ export interface IDestinyEquipmentSlotDefinition { */ readonly applyCustomArtDyes: boolean; /** The Art Dye Channels that apply to this equipment slot. */ - readonly artDyeChannels: IDestinyArtDyeReference[]; + readonly artDyeChannels: DestinyArtDyeReference[]; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -2552,8 +2628,8 @@ export interface IDestinyEquipmentSlotDefinition { * This is how transfer functionality like the Vault is implemented, as a feature * of a Vendor. See the vendor's acceptedItems property for more details. */ -export interface IDestinyInventoryBucketDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyInventoryBucketDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** Where the bucket is found. 0 = Character, 1 = Account */ readonly scope: BucketScope; /** @@ -2645,10 +2721,26 @@ export const enum ItemLocation { Postmaster = 4 } -export interface IDestinyArtDyeReference { +export interface DestinyArtDyeReference { readonly artDyeChannelHash: number; } +/** + * This Enumeration further classifies items by more specific categorizations than + * DestinyItemType. The "Sub-Type" is where we classify and categorize items one + * step further in specificity: "Auto Rifle" instead of just "Weapon" for example, + * or "Vanguard Bounty" instead of merely "Bounty". + * + * These sub-types are provided for historical compatibility with Destiny 1, but an + * ideal alternative is to use DestinyItemCategoryDefinitions and the + * DestinyItemDefinition.itemCategories property instead. Item Categories allow for + * arbitrary hierarchies of specificity, and for items to belong to multiple + * categories across multiple hierarchies simultaneously. For this enum, we pick a + * single type as a "best guess" fit. + * + * NOTE: This is not all of the item types available, and some of these are + * holdovers from Destiny 1 that may or may not still exist. + */ export const enum DestinyItemSubType { None = 0, /** DEPRECATED. Items can be both "Crucible" and something else interesting. */ @@ -2696,7 +2788,7 @@ export const enum DestinyItemSubType { * at phase indexes in stats data, or when they want to know what phases have been * completed on a weekly achievement. */ -export interface IDestinyActivityInsertionPointDefinition { +export interface DestinyActivityInsertionPointDefinition { /** * A unique hash value representing the phase. This can be useful for, for example, * comparing how different instances of Raids have phases in different orders! @@ -2704,11 +2796,11 @@ export interface IDestinyActivityInsertionPointDefinition { readonly phaseHash: number; } -export interface IDestinyEnvironmentLocationMapping { +export interface DestinyEnvironmentLocationMapping { /** * The location that is revealed on the director by this mapping. * - * Mapped to IDestinyLocationDefinition in the manifest. + * Mapped to DestinyLocationDefinition in the manifest. */ readonly locationHash: number; /** @@ -2721,13 +2813,13 @@ export interface IDestinyEnvironmentLocationMapping { * be active because of this mapping. (theoretically, a location can have multiple * mappings, and some might require an item while others don't) * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly itemHash?: number; /** * If this is populated, this is an objective related to the location. * - * Mapped to IDestinyObjectiveDefinition in the manifest. + * Mapped to DestinyObjectiveDefinition in the manifest. */ readonly objectiveHash?: number; /** @@ -2736,7 +2828,7 @@ export interface IDestinyEnvironmentLocationMapping { * have multiple mappings, and some might require you to be in a specific activity * when others don't) * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly activityHash?: number; } @@ -2747,8 +2839,8 @@ export interface IDestinyEnvironmentLocationMapping { * * DEPRECATED - Just use bubbles. */ -export interface IDestinyDestinationBubbleSettingDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyDestinationBubbleSettingDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; } /** @@ -2756,7 +2848,7 @@ export interface IDestinyDestinationBubbleSettingDefinition { * DestinyDestinationBubbleSettingDefinition - see DestinyDestinationDefinition. * bubbleSettings for more information. */ -export interface IDestinyBubbleDefinition { +export interface DestinyBubbleDefinition { /** * The identifier for the bubble: only guaranteed to be unique within the * Destination. @@ -2766,7 +2858,7 @@ export interface IDestinyBubbleDefinition { * The display properties of this bubble, so you don't have to look them up in a * separate list anymore. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; } /** @@ -2775,7 +2867,7 @@ export interface IDestinyBubbleDefinition { * as it is unused and unclear if it will ever be used... but in case it is ever * populated and someone finds it useful, it is defined here. */ -export interface IDestinyVendorActionDefinition { +export interface DestinyVendorActionDefinition { readonly description: string; readonly executeSeconds: number; readonly icon: string; @@ -2791,7 +2883,7 @@ export interface IDestinyVendorActionDefinition { * This is the definition for a single Vendor Category, into which Sale Items are * grouped. */ -export interface IDestinyVendorCategoryEntryDefinition { +export interface DestinyVendorCategoryEntryDefinition { /** The index of the category in the original category definitions for the vendor. */ readonly categoryIndex: number; /** The string identifier of the category. */ @@ -2832,7 +2924,7 @@ export interface IDestinyVendorCategoryEntryDefinition { * If this category has an overlay prompt that should appear, this contains the * details of that prompt. */ - readonly overlay: IDestinyVendorCategoryOverlayDefinition; + readonly overlay: DestinyVendorCategoryOverlayDefinition; /** * A shortcut for the vendor item indexes sold under this category. Saves us from * some expensive reorganization at runtime. @@ -2854,7 +2946,7 @@ export interface IDestinyVendorCategoryEntryDefinition { * The details of an overlay prompt to show to a user. They are all fairly self- * explanatory localized strings that can be shown. */ -export interface IDestinyVendorCategoryOverlayDefinition { +export interface DestinyVendorCategoryOverlayDefinition { readonly choiceDescription: string; readonly description: string; readonly icon: string; @@ -2870,11 +2962,11 @@ export interface IDestinyVendorCategoryOverlayDefinition { * categorized entirely separately from "Display Categories", there need be and * often will be no meaningful relationship between the two. */ -export interface IDestinyDisplayCategoryDefinition { +export interface DestinyDisplayCategoryDefinition { /** A string identifier for the display category. */ readonly identifier: string; readonly displayCategoryHash: number; - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * If true, this category should be displayed in the "Banner" section of the vendor' * s UI. @@ -2887,7 +2979,7 @@ export interface IDestinyDisplayCategoryDefinition { * Specific categories can now have thier own distinct progression, apparently. So * that's cool. * - * Mapped to IDestinyProgressionDefinition in the manifest. + * Mapped to DestinyProgressionDefinition in the manifest. */ readonly progressionHash?: number; /** If this category sorts items in a nonstandard way, this will be the way we sort. */ @@ -2906,6 +2998,7 @@ export interface IDestinyDisplayCategoryDefinition { readonly displayStyleIdentifier: string; } +/** Display categories can have custom sort orders. These are the possible options. */ export const enum VendorDisplayCategorySortOrder { Default = 0, SortByTier = 1 @@ -2916,14 +3009,14 @@ export const enum VendorDisplayCategorySortOrder { * transfer screens. The vendor is showing you something, and asking you to reply * to it by choosing an option or reward. */ -export interface IDestinyVendorInteractionDefinition { +export interface DestinyVendorInteractionDefinition { /** * The position of this interaction in its parent array. Note that this is NOT * content agnostic, and should not be used as such. */ readonly interactionIndex: number; /** The potential replies that the user can make to the interaction. */ - readonly replies: IDestinyVendorInteractionReplyDefinition[]; + readonly replies: DestinyVendorInteractionReplyDefinition[]; /** * If >= 0, this is the category of sale items to show along with this interaction * dialog. @@ -2936,14 +3029,14 @@ export interface IDestinyVendorInteractionDefinition { * Quest Step by checking their inventory against this questlineItemHash's * DestinyInventoryItemDefinition.setData. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly questlineItemHash: number; /** * If this interaction is meant to show you sacks, this is the list of types of * sacks to be shown. If empty, the interaction is not meant to show sacks. */ - readonly sackInteractionList: IDestinyVendorInteractionSackEntryDefinition[]; + readonly sackInteractionList: DestinyVendorInteractionSackEntryDefinition[]; /** * A UI hint for the behavior of the interaction screen. This is useful to * determine what type of interaction is occurring, such as a prompt to receive a @@ -2972,7 +3065,7 @@ export interface IDestinyVendorInteractionDefinition { /** If the vendor interaction has flavor text, this is the rest of it. */ readonly flavorLineTwo: string; /** The header for the interaction dialog. */ - readonly headerDisplayProperties: IDestinyDisplayPropertiesDefinition; + readonly headerDisplayProperties: DestinyDisplayPropertiesDefinition; /** The localized text telling the player what to do when they see this dialog. */ readonly instructions: string; } @@ -2984,7 +3077,7 @@ export interface IDestinyVendorInteractionDefinition { * You can potentially choose one from multiple replies when replying to an * interaction: this is how you get either/or rewards from vendors. */ -export interface IDestinyVendorInteractionReplyDefinition { +export interface DestinyVendorInteractionReplyDefinition { /** The rewards granted upon responding to the vendor. */ readonly itemRewardsSelection: DestinyVendorInteractionRewardSelection; /** The localized text for the reply. */ @@ -2993,12 +3086,17 @@ export interface IDestinyVendorInteractionReplyDefinition { readonly replyType: DestinyVendorReplyType; } +/** + * When a Vendor Interaction provides rewards, they'll either let you choose one or + * let you have all of them. This determines which it will be. + */ export const enum DestinyVendorInteractionRewardSelection { None = 0, One = 1, All = 2 } +/** This determines the type of reply that a Vendor will have during an Interaction. */ export const enum DestinyVendorReplyType { Accept = 0, Decline = 1, @@ -3010,10 +3108,11 @@ export const enum DestinyVendorReplyType { * DestinyInventoryItemDefinition.vendorSackType property of items. If they match, * show this sack with this interaction. */ -export interface IDestinyVendorInteractionSackEntryDefinition { +export interface DestinyVendorInteractionSackEntryDefinition { readonly sackType: number; } +/** An enumeration of the known UI interactions for Vendors. */ export const enum VendorInteractionType { Unknown = 0, /** An interaction shown when you complete a quest and receive a reward. */ @@ -3047,13 +3146,13 @@ export const enum VendorInteractionType { * The definition for an "inventory flyout": a UI screen where we show you part of * an otherwise hidden vendor inventory: like the Vault inventory buckets. */ -export interface IDestinyVendorInventoryFlyoutDefinition { +export interface DestinyVendorInventoryFlyoutDefinition { /** If the flyout is locked, this is the reason why. */ readonly lockedDescription: string; /** The title and other common properties of the flyout. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** A list of inventory buckets and other metadata to show on the screen. */ - readonly buckets: IDestinyVendorInventoryFlyoutBucketDefinition[]; + readonly buckets: DestinyVendorInventoryFlyoutBucketDefinition[]; /** An identifier for the flyout, in case anything else needs to refer to them. */ readonly flyoutId: number; /** @@ -3072,19 +3171,20 @@ export interface IDestinyVendorInventoryFlyoutDefinition { * Information about a single inventory bucket in a vendor flyout UI and how it is * shown. */ -export interface IDestinyVendorInventoryFlyoutBucketDefinition { +export interface DestinyVendorInventoryFlyoutBucketDefinition { /** If true, the inventory bucket should be able to be collapsed visually. */ readonly collapsible: boolean; /** * The inventory bucket whose contents should be shown. * - * Mapped to IDestinyInventoryBucketDefinition in the manifest. + * Mapped to DestinyInventoryBucketDefinition in the manifest. */ readonly inventoryBucketHash: number; /** The methodology to use for sorting items from the flyout. */ readonly sortItemsBy: DestinyItemSortType; } +/** Determines how items are sorted in an inventory bucket. */ export const enum DestinyItemSortType { ItemId = 0, Timestamp = 1, @@ -3092,7 +3192,7 @@ export const enum DestinyItemSortType { } /** This represents an item being sold by the vendor. */ -export interface IDestinyVendorItemDefinition { +export interface DestinyVendorItemDefinition { /** * The index into the DestinyVendorDefinition.saleList. This is what we use to * refer to items being sold throughout live and definition data. @@ -3104,7 +3204,7 @@ export interface IDestinyVendorItemDefinition { * Note that a vendor can sell the same item in multiple ways, so don't assume that * itemHash is a unique identifier for this entity. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly itemHash: number; /** @@ -3126,7 +3226,7 @@ export interface IDestinyVendorItemDefinition { * have dynamic modifiers, this will not necessarily be statically true. If you * were using this instead of live data, switch to using live data. */ - readonly currencies: IDestinyVendorItemQuantity[]; + readonly currencies: DestinyVendorItemQuantity[]; /** * If this item can be refunded, this is the policy for what will be refundd, how, * and in what time period. @@ -3139,7 +3239,7 @@ export interface IDestinyVendorItemDefinition { * adjusto these days. Ideally should be singular. It's a long story how this ended * up as a list, but there is always either going to be 0:1 of these entities. */ - readonly creationLevels: IDestinyItemCreationEntryLevelDefinition[]; + readonly creationLevels: DestinyItemCreationEntryLevelDefinition[]; /** * This is an index specifically into the display category, as opposed to the * server-side Categories (which do not need to match or pair with each other in @@ -3159,7 +3259,7 @@ export interface IDestinyVendorItemDefinition { /** The maximum character level at which this item is available for sale. */ readonly maximumLevel: number; /** The action to be performed when purchasing the item, if it's not just "buy". */ - readonly action: IDestinyVendorSaleItemActionBlockDefinition; + readonly action: DestinyVendorSaleItemActionBlockDefinition; /** The string identifier for the category selling this item. */ readonly displayCategory: string; /** The inventory bucket into which this item will be placed upon purchase. */ @@ -3208,7 +3308,7 @@ export interface IDestinyVendorItemDefinition { * these other items instead. */ readonly redirectToSaleIndexes: number[]; - readonly socketOverrides: IDestinyVendorItemSocketOverride[]; + readonly socketOverrides: DestinyVendorItemSocketOverride[]; } /** @@ -3217,12 +3317,12 @@ export interface IDestinyVendorItemDefinition { * modified. (unfortunately not information that is able to be read outside of the * BNet servers, but it's there) */ -export interface IDestinyVendorItemQuantity { +export interface DestinyVendorItemQuantity { /** * The hash identifier for the item in question. Use it to look up the item's * DestinyInventoryItemDefinition. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly itemHash: number; /** @@ -3237,6 +3337,7 @@ export interface IDestinyVendorItemQuantity { readonly quantity: number; } +/** The action that happens when the user attempts to refund an item. */ export const enum DestinyVendorItemRefundPolicy { NotRefundable = 0, DeletesItem = 1, @@ -3244,12 +3345,12 @@ export const enum DestinyVendorItemRefundPolicy { } /** An overly complicated wrapper for the item level at which the item should spawn. */ -export interface IDestinyItemCreationEntryLevelDefinition { +export interface DestinyItemCreationEntryLevelDefinition { readonly level: number; } /** Not terribly useful, some basic cooldown interaction info. */ -export interface IDestinyVendorSaleItemActionBlockDefinition { +export interface DestinyVendorSaleItemActionBlockDefinition { readonly executeSeconds: number; readonly isPositive: boolean; } @@ -3258,7 +3359,7 @@ export interface IDestinyVendorSaleItemActionBlockDefinition { * The information for how the vendor purchase should override a given socket with * custom plug data. */ -export interface IDestinyVendorItemSocketOverride { +export interface DestinyVendorItemSocketOverride { /** * If this is populated, the socket will be overridden with a specific plug. * @@ -3266,7 +3367,7 @@ export interface IDestinyVendorItemSocketOverride { * that is only known by the Game Server and God, which means we can't tell you in * advance what it'll be. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly singleItemHash?: number; /** @@ -3278,7 +3379,7 @@ export interface IDestinyVendorItemSocketOverride { * This appears to be used to select which socket ultimately gets the override * defined here. * - * Mapped to IDestinySocketTypeDefinition in the manifest. + * Mapped to DestinySocketTypeDefinition in the manifest. */ readonly socketTypeHash: number; } @@ -3292,15 +3393,15 @@ export interface IDestinyVendorItemSocketOverride { * See DestinyInventoryItemDefinition for more information about Socketed items and * Plugs. */ -export interface IDestinySocketTypeDefinition { +export interface DestinySocketTypeDefinition { /** * There are fields for this display data, but they appear to be unpopulated as of * now. I am not sure where in the UI these would show if they even were populated, * but I will continue to return this data in case it becomes useful. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** Defines what happens when a plug is inserted into sockets of this type. */ - readonly insertAction: IDestinyInsertPlugActionDefinition; + readonly insertAction: DestinyInsertPlugActionDefinition; /** * A list of Plug "Categories" that are allowed to be plugged into sockets of this * type. @@ -3312,8 +3413,8 @@ export interface IDestinySocketTypeDefinition { * If the plug's category matches any whitelisted plug, or if the whitelist is * empty, it is allowed to be inserted. */ - readonly plugWhitelist: IDestinyPlugWhitelistEntryDefinition[]; - /** Mapped to IDestinySocketCategoryDefinition in the manifest. */ + readonly plugWhitelist: DestinyPlugWhitelistEntryDefinition[]; + /** Mapped to DestinySocketCategoryDefinition in the manifest. */ readonly socketCategoryHash: number; /** * Sometimes a socket isn't visible. These are some of the conditions under which @@ -3331,7 +3432,7 @@ export interface IDestinySocketTypeDefinition { */ readonly overridesUiAppearance: boolean; readonly avoidDuplicatesOnInitialization: boolean; - readonly currencyScalars: IDestinySocketTypeScalarMaterialRequirementEntry[]; + readonly currencyScalars: DestinySocketTypeScalarMaterialRequirementEntry[]; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -3353,7 +3454,7 @@ export interface IDestinySocketTypeDefinition { * Data related to what happens while a plug is being inserted, mostly for UI * purposes. */ -export interface IDestinyInsertPlugActionDefinition { +export interface DestinyInsertPlugActionDefinition { /** * How long it takes for the Plugging of the item to be completed once it is * initiated, if you care. @@ -3368,6 +3469,7 @@ export interface IDestinyInsertPlugActionDefinition { readonly actionType: SocketTypeActionType; } +/** Indicates the type of actions that can be performed */ export const enum SocketTypeActionType { InsertPlug = 0, InfuseItem = 1, @@ -3382,7 +3484,7 @@ export const enum SocketTypeActionType { * DestinyInventoryItemDefinition.plug.plugCategoryHash, which indicates the plug * item's category. */ -export interface IDestinyPlugWhitelistEntryDefinition { +export interface DestinyPlugWhitelistEntryDefinition { /** * The hash identifier of the Plug Category to compare against the plug item's plug. * plugCategoryHash. @@ -3436,8 +3538,8 @@ export interface IDestinyPlugWhitelistEntryDefinition { * the consistency of plugSources is the best I have time to provide. (See https:// * github.com/Bungie-net/api/issues/522 for more info) */ -export interface IDestinySocketCategoryDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinySocketCategoryDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * A string hinting to the game's UI system about how the sockets in this category * should be displayed. @@ -3465,6 +3567,10 @@ export interface IDestinySocketCategoryDefinition { readonly redacted: boolean; } +/** + * Represents the possible and known UI styles used by the game for rendering + * Socket Categories. + */ export const enum DestinySocketCategoryStyle { Unknown = 0, Reusable = 1, @@ -3480,13 +3586,13 @@ export const enum DestinySocketVisibility { HiddenIfNoPlugsAvailable = 3 } -export interface IDestinySocketTypeScalarMaterialRequirementEntry { +export interface DestinySocketTypeScalarMaterialRequirementEntry { readonly currencyItemHash: number; readonly scalarValue: number; } /** When a vendor provides services, this is the localized name of those services. */ -export interface IDestinyVendorServiceDefinition { +export interface DestinyVendorServiceDefinition { /** The localized name of a service provided. */ readonly name: string; } @@ -3503,7 +3609,7 @@ export interface IDestinyVendorServiceDefinition { * The mechanics for Postmaster works similarly, which is also a vendor. All driven * by Accepted Items. */ -export interface IDestinyVendorAcceptedItemDefinition { +export interface DestinyVendorAcceptedItemDefinition { /** * The "source" bucket for a transfer. When a user wants to transfer an item, the * appropriate DestinyVendorDefinition's acceptedItems property is evaluated, @@ -3511,14 +3617,14 @@ export interface IDestinyVendorAcceptedItemDefinition { * the item being transferred is currently located. If it exists, the item will be * transferred into whatever bucket is defined by destinationInventoryBucketHash. * - * Mapped to IDestinyInventoryBucketDefinition in the manifest. + * Mapped to DestinyInventoryBucketDefinition in the manifest. */ readonly acceptedInventoryBucketHash: number; /** * This is the bucket where the item being transferred will be put, given that it * was being transferred *from* the bucket defined in acceptedInventoryBucketHash. * - * Mapped to IDestinyInventoryBucketDefinition in the manifest. + * Mapped to DestinyInventoryBucketDefinition in the manifest. */ readonly destinationInventoryBucketHash: number; } @@ -3527,12 +3633,12 @@ export interface IDestinyVendorAcceptedItemDefinition { * These definitions represent vendors' locations and relevant display information * at different times in the game. */ -export interface IDestinyVendorLocationDefinition { +export interface DestinyVendorLocationDefinition { /** * The hash identifier for a Destination at which this vendor may be located. Each * destination where a Vendor may exist will only ever have a single entry. * - * Mapped to IDestinyDestinationDefinition in the manifest. + * Mapped to DestinyDestinationDefinition in the manifest. */ readonly destinationHash: number; /** @@ -3542,11 +3648,11 @@ export interface IDestinyVendorLocationDefinition { readonly backgroundImagePath: string; } -export interface IDestinyVendorGroupReference { +export interface DestinyVendorGroupReference { /** * The DestinyVendorGroupDefinition to which this Vendor can belong. * - * Mapped to IDestinyVendorGroupDefinition in the manifest. + * Mapped to DestinyVendorGroupDefinition in the manifest. */ readonly vendorGroupHash: number; } @@ -3564,7 +3670,7 @@ export interface IDestinyVendorGroupReference { * Using this will let you group your vendors in your UI in a similar manner to how * we will do grouping in the Companion. */ -export interface IDestinyVendorGroupDefinition { +export interface DestinyVendorGroupDefinition { /** The recommended order in which to render the groups, Ascending order. */ readonly order: number; /** For now, a group just has a name. */ @@ -3590,9 +3696,9 @@ export interface IDestinyVendorGroupDefinition { * A specific "spot" referred to by a location. Only one of these can be active at * a time for a given Location. */ -export interface IDestinyLocationReleaseDefinition { +export interface DestinyLocationReleaseDefinition { /** Sadly, these don't appear to be populated anymore (ever?) */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; readonly smallTransparentIcon: string; readonly mapIcon: string; readonly largeTransparentIcon: string; @@ -3604,13 +3710,13 @@ export interface IDestinyLocationReleaseDefinition { /** * The Destination being pointed to by this location. * - * Mapped to IDestinyDestinationDefinition in the manifest. + * Mapped to DestinyDestinationDefinition in the manifest. */ readonly destinationHash: number; /** * The Activity being pointed to by this location. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly activityHash: number; /** The Activity Graph being pointed to by this location. */ @@ -3666,6 +3772,11 @@ export const enum DestinyActivityNavPointType { TrackedQuest = 16 } +/** + * If you're showing an unlock value in the UI, this is the format in which it + * should be shown. You'll have to build your own algorithms on the client side to + * determine how best to render these options. + */ export const enum DestinyUnlockValueUIStyle { /** Generally, Automatic means "Just show the number" */ Automatic = 0, @@ -3718,12 +3829,12 @@ export const enum DestinyUnlockValueUIStyle { * These perks will generally not be benefit-granting perks, but rather a perk that * modifies gameplay in some interesting way. */ -export interface IDestinyObjectivePerkEntryDefinition { +export interface DestinyObjectivePerkEntryDefinition { /** * The hash identifier of the DestinySandboxPerkDefinition that will be applied to * the character. * - * Mapped to IDestinySandboxPerkDefinition in the manifest. + * Mapped to DestinySandboxPerkDefinition in the manifest. */ readonly perkHash: number; /** @@ -3753,13 +3864,13 @@ export interface IDestinyObjectivePerkEntryDefinition { * care about anyways. The others are left as a mystery, their true purpose mostly * unknown and undocumented. */ -export interface IDestinySandboxPerkDefinition { +export interface DestinySandboxPerkDefinition { /** * These display properties are by no means guaranteed to be populated. Usually * when it is, it's only because we back-filled them with the displayProperties of * some Talent Node or Plug item that happened to be uniquely providing that perk. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** The string identifier for the perk. */ readonly perkIdentifier: string; /** @@ -3790,7 +3901,7 @@ export interface IDestinySandboxPerkDefinition { * It is as yet unpopulated, and there will be quite a bit of work needed to * restore it to its former working order. */ - readonly perkGroups: IDestinyTalentNodeStepGroups; + readonly perkGroups: DestinyTalentNodeStepGroups; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -3822,14 +3933,38 @@ export const enum DamageType { * common properties. See the related enumerations for the type of properties being * categorized. */ -export interface IDestinyTalentNodeStepGroups { +export interface DestinyTalentNodeStepGroups { + /** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ readonly weaponPerformance: DestinyTalentNodeStepWeaponPerformances; + /** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ readonly impactEffects: DestinyTalentNodeStepImpactEffects; + /** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ readonly guardianAttributes: DestinyTalentNodeStepGuardianAttributes; + /** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ readonly lightAbilities: DestinyTalentNodeStepLightAbilities; + /** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ readonly damageTypes: DestinyTalentNodeStepDamageTypes; } +/** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum DestinyTalentNodeStepWeaponPerformances { None = 0, RateOfFire = 1, @@ -3848,6 +3983,10 @@ export const enum DestinyTalentNodeStepWeaponPerformances { All = 8191 } +/** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum DestinyTalentNodeStepImpactEffects { None = 0, ArmorPiercing = 1, @@ -3859,6 +3998,10 @@ export const enum DestinyTalentNodeStepImpactEffects { All = 63 } +/** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum DestinyTalentNodeStepGuardianAttributes { None = 0, Stats = 1, @@ -3872,6 +4015,10 @@ export const enum DestinyTalentNodeStepGuardianAttributes { All = 255 } +/** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum DestinyTalentNodeStepLightAbilities { None = 0, Grenades = 1, @@ -3883,6 +4030,10 @@ export const enum DestinyTalentNodeStepLightAbilities { All = 63 } +/** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum DestinyTalentNodeStepDamageTypes { None = 0, Kinetic = 1, @@ -3892,6 +4043,11 @@ export const enum DestinyTalentNodeStepDamageTypes { All = 15 } +/** + * Some Objectives provide perks, generally as part of providing some kind of + * interesting modifier for a Challenge or Quest. This indicates when the Perk is + * granted. + */ export const enum DestinyObjectiveGrantStyle { WhenIncomplete = 0, WhenComplete = 1, @@ -3902,9 +4058,9 @@ export const enum DestinyObjectiveGrantStyle { * Defines the conditions under which stat modifications will be applied to a * Character while participating in an objective. */ -export interface IDestinyObjectiveStatEntryDefinition { +export interface DestinyObjectiveStatEntryDefinition { /** The stat being modified, and the value used. */ - readonly stat: IDestinyItemInvestmentStatDefinition; + readonly stat: DestinyItemInvestmentStatDefinition; /** * Whether it will be applied as long as the objective is active, when it's * completed, or until it's completed. @@ -3921,11 +4077,11 @@ export interface IDestinyObjectiveStatEntryDefinition { * really want to use these stats. I have left them in case someone can do * something useful or interesting with the pre-processed statistics. */ -export interface IDestinyItemInvestmentStatDefinition { +export interface DestinyItemInvestmentStatDefinition { /** * The hash identifier for the DestinyStatDefinition defining this stat. * - * Mapped to IDestinyStatDefinition in the manifest. + * Mapped to DestinyStatDefinition in the manifest. */ readonly statTypeHash: number; /** @@ -3999,8 +4155,8 @@ export interface IDestinyItemInvestmentStatDefinition { * is not actually displayed to the user, with the exception of Magazine Size which * is then piped back to the UI for display in-game, but not to BNet.) */ -export interface IDestinyStatDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyStatDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * Stats can exist on a character or an item, and they may potentially be * aggregated in different ways. The DestinyStatAggregationType enum value @@ -4032,12 +4188,24 @@ export interface IDestinyStatDefinition { readonly redacted: boolean; } +/** + * When a Stat (DestinyStatDefinition) is aggregated, this is the rules used for + * determining the level and formula used for aggregation. + * + * * CharacterAverage = apply a weighted average using the related + * DestinyStatGroupDefinition on the DestinyInventoryItemDefinition across the + * character's equipped items. See both of those definitions for details. * + * Character = don't aggregate: the stat should be located and used directly on the + * character. * Item = don't aggregate: the stat should be located and used + * directly on the item. + */ export const enum DestinyStatAggregationType { CharacterAverage = 0, Character = 1, Item = 2 } +/** At last, stats have categories. Use this for whatever purpose you might wish. */ export const enum DestinyStatCategory { Gameplay = 0, Weapon = 1, @@ -4045,23 +4213,32 @@ export const enum DestinyStatCategory { Primary = 3 } -export interface IDestinyRecordDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyRecordDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * Indicates whether this Record's state is determined on a per-character or on an * account-wide basis. */ readonly scope: DestinyScope; - readonly presentationInfo: IDestinyPresentationChildBlock; - /** Mapped to IDestinyLoreDefinition in the manifest. */ + readonly presentationInfo: DestinyPresentationChildBlock; + /** Mapped to DestinyLoreDefinition in the manifest. */ readonly loreHash?: number; - /** Mapped to IDestinyObjectiveDefinition in the manifest. */ + /** Mapped to DestinyObjectiveDefinition in the manifest. */ readonly objectiveHashes: number[]; readonly recordValueStyle: DestinyRecordValueStyle; - readonly titleInfo: IDestinyRecordTitleBlock; - readonly completionInfo: IDestinyRecordCompletionBlock; - readonly stateInfo: ISchemaRecordStateBlock; - readonly requirements: IDestinyPresentationNodeRequirementsBlock; + readonly titleInfo: DestinyRecordTitleBlock; + readonly completionInfo: DestinyRecordCompletionBlock; + readonly stateInfo: SchemaRecordStateBlock; + readonly requirements: DestinyPresentationNodeRequirementsBlock; + readonly expirationInfo: DestinyRecordExpirationBlock; + /** + * If there is any publicly available information about rewards earned for + * achieving this record, this is the list of those items. + * + * However, note that some records intentionally have "hidden" rewards. These will + * not be returned in this list. + */ + readonly rewardItems: DestinyItemQuantity[]; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -4087,8 +4264,8 @@ export interface IDestinyRecordDefinition { * but nothing's stopping you from scraping all of these and doing something cool * with them. If they end up having cool data. */ -export interface IDestinyLoreDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyLoreDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; readonly subtitle: string; /** * The unique identifier for this entity. Guaranteed to be unique for the type of @@ -4115,13 +4292,13 @@ export const enum DestinyRecordValueStyle { Decimal = 4 } -export interface IDestinyRecordTitleBlock { +export interface DestinyRecordTitleBlock { readonly hasTitle: boolean; - readonly titlesByGender: { [key: number]: string }; + readonly titlesByGender: { [key in DestinyGender]: string }; /** * For those who prefer to use the definitions. * - * Mapped to IDestinyGenderDefinition in the manifest. + * Mapped to DestinyGenderDefinition in the manifest. */ readonly titlesByGenderHash: { [key: number]: string }; } @@ -4130,14 +4307,14 @@ export interface IDestinyRecordTitleBlock { * Gender is a social construct, and as such we have definitions for Genders. Right * now there happens to only be two, but we'll see what the future holds. */ -export interface IDestinyGenderDefinition { +export interface DestinyGenderDefinition { /** * This is a quick reference enumeration for all of the currently defined Genders. * We use the enumeration for quicker lookups in related data, like * DestinyClassDefinition.genderedClassNames. */ readonly genderType: DestinyGender; - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -4161,7 +4338,7 @@ export const enum DestinyGender { Unknown = 2 } -export interface IDestinyRecordCompletionBlock { +export interface DestinyRecordCompletionBlock { /** * The number of objectives that must be completed before the objective is * considered "complete" @@ -4181,11 +4358,21 @@ export const enum DestinyRecordToastStyle { MedalComplete = 5 } -export interface ISchemaRecordStateBlock { +export interface SchemaRecordStateBlock { readonly featuredPriority: number; readonly obscuredString: string; } +/** + * If this record has an expiration after which it cannot be earned, this is some + * information about that expiration. + */ +export interface DestinyRecordExpirationBlock { + readonly hasExpiration: boolean; + readonly description: string; + readonly icon: string; +} + /** * As/if presentation nodes begin to host more entities as children, these lists * will be added to. One list property exists per type of entity that can be @@ -4193,27 +4380,31 @@ export interface ISchemaRecordStateBlock { * the entity and any associated information needed to display the UI for that * entity (if anything) */ -export interface IDestinyPresentationNodeChildrenBlock { - readonly presentationNodes: IDestinyPresentationNodeChildEntry[]; - readonly collectibles: IDestinyPresentationNodeCollectibleChildEntry[]; - readonly records: IDestinyPresentationNodeRecordChildEntry[]; +export interface DestinyPresentationNodeChildrenBlock { + readonly presentationNodes: DestinyPresentationNodeChildEntry[]; + readonly collectibles: DestinyPresentationNodeCollectibleChildEntry[]; + readonly records: DestinyPresentationNodeRecordChildEntry[]; } -export interface IDestinyPresentationNodeChildEntry { - /** Mapped to IDestinyPresentationNodeDefinition in the manifest. */ +export interface DestinyPresentationNodeChildEntry { + /** Mapped to DestinyPresentationNodeDefinition in the manifest. */ readonly presentationNodeHash: number; } -export interface IDestinyPresentationNodeCollectibleChildEntry { - /** Mapped to IDestinyCollectibleDefinition in the manifest. */ +export interface DestinyPresentationNodeCollectibleChildEntry { + /** Mapped to DestinyCollectibleDefinition in the manifest. */ readonly collectibleHash: number; } -export interface IDestinyPresentationNodeRecordChildEntry { - /** Mapped to IDestinyRecordDefinition in the manifest. */ +export interface DestinyPresentationNodeRecordChildEntry { + /** Mapped to DestinyRecordDefinition in the manifest. */ readonly recordHash: number; } +/** + * A hint for how the presentation node should be displayed when shown in a list. + * How you use this is your UI is up to you. + */ export const enum DestinyPresentationDisplayStyle { /** Display the item as a category, through which sub-items are filtered. */ Category = 0, @@ -4223,6 +4414,10 @@ export const enum DestinyPresentationDisplayStyle { Record = 4 } +/** + * A hint for what screen should be shown when this presentation node is clicked + * into. How you use this is your UI is up to you. + */ export const enum DestinyPresentationScreenStyle { /** Use the "default" view for the presentation nodes. */ Default = 0, @@ -4243,7 +4438,7 @@ export const enum DestinyPresentationScreenStyle { * Represents a color whose RGBA values are all represented as values between 0 and * 255. */ -export interface IDestinyColor { +export interface DestinyColor { readonly red: number; readonly green: number; readonly blue: number; @@ -4254,7 +4449,7 @@ export interface IDestinyColor { * If an item can have an action performed on it (like "Dismantle"), it will be * defined here if you care. */ -export interface IDestinyItemActionBlockDefinition { +export interface DestinyItemActionBlockDefinition { /** Localized text for the verb of the action being performed. */ readonly verbName: string; /** Localized text describing the action being performed. */ @@ -4274,12 +4469,12 @@ export interface IDestinyItemActionBlockDefinition { * If the action requires other items to exist or be destroyed, this is the list of * those items and requirements. */ - readonly requiredItems: IDestinyItemActionRequiredItemDefinition[]; + readonly requiredItems: DestinyItemActionRequiredItemDefinition[]; /** * If performing this action earns you Progression, this is the list of * progressions and values granted for those progressions by performing this action. */ - readonly progressionRewards: IDestinyProgressionRewardDefinition[]; + readonly progressionRewards: DestinyProgressionRewardDefinition[]; /** The internal identifier for the action. */ readonly actionTypeLabel: string; /** @@ -4310,14 +4505,14 @@ export interface IDestinyItemActionBlockDefinition { * The definition of an item and quantity required in a character's inventory in * order to perform an action. */ -export interface IDestinyItemActionRequiredItemDefinition { +export interface DestinyItemActionRequiredItemDefinition { /** The minimum quantity of the item you have to have. */ readonly count: number; /** * The hash identifier of the item you need to have. Use it to look up the * DestinyInventoryItemDefinition for more info. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly itemHash: number; /** @@ -4337,12 +4532,12 @@ export interface IDestinyItemActionRequiredItemDefinition { * DestinyProgressionDefinition directly. This is apparently so that multiple * progressions can be granted progression points/experience at the same time. */ -export interface IDestinyProgressionRewardDefinition { +export interface DestinyProgressionRewardDefinition { /** * The hash identifier of the DestinyProgressionMappingDefinition that contains the * progressions for which experience should be applied. * - * Mapped to IDestinyProgressionMappingDefinition in the manifest. + * Mapped to DestinyProgressionMappingDefinition in the manifest. */ readonly progressionMappingHash: number; /** The amount of experience to give to each of the mapped progressions. */ @@ -4360,12 +4555,12 @@ export interface IDestinyProgressionRewardDefinition { * These are used to apply rewards to multiple progressions at once. They can * sometimes have human readable data as well, but only extremely sporadically. */ -export interface IDestinyProgressionMappingDefinition { +export interface DestinyProgressionMappingDefinition { /** * Infrequently defined in practice. Defer to the individual progressions' display * properties. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * The localized unit of measurement for progression across the progressions * defined in this mapping. Unfortunately, this is very infrequently defined. Defer @@ -4394,7 +4589,7 @@ export interface IDestinyProgressionMappingDefinition { * and do - then this is the basic properties regarding the item's relationship * with the inventory. */ -export interface IDestinyItemInventoryBlockDefinition { +export interface DestinyItemInventoryBlockDefinition { /** * If this string is populated, you can't have more than one stack with this label * in a given inventory. Note that this is different from the equipping block's @@ -4408,7 +4603,7 @@ export interface IDestinyItemInventoryBlockDefinition { * belongs. I should have named this "bucketHash", but too many things refer to it * now. Sigh. * - * Mapped to IDestinyInventoryBucketDefinition in the manifest. + * Mapped to DestinyInventoryBucketDefinition in the manifest. */ readonly bucketTypeHash: number; /** @@ -4416,7 +4611,7 @@ export interface IDestinyItemInventoryBlockDefinition { * the DestinyInventoryBucketDefinition into which it will be placed. Again, I * should have named this recoveryBucketHash instead. * - * Mapped to IDestinyInventoryBucketDefinition in the manifest. + * Mapped to DestinyInventoryBucketDefinition in the manifest. */ readonly recoveryBucketTypeHash: number; /** @@ -4424,7 +4619,7 @@ export interface IDestinyItemInventoryBlockDefinition { * DestinyItemTierTypeDefinition if you need to show localized data for the item's * tier. * - * Mapped to IDestinyItemTierTypeDefinition in the manifest. + * Mapped to DestinyItemTierTypeDefinition in the manifest. */ readonly tierTypeHash: number; /** @@ -4461,10 +4656,10 @@ export interface IDestinyItemInventoryBlockDefinition { * * It also provides some base data for infusion that could be useful. */ -export interface IDestinyItemTierTypeDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyItemTierTypeDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** If this tier defines infusion properties, they will be contained here. */ - readonly infusionProcess: IDestinyItemTierTypeInfusionBlock; + readonly infusionProcess: DestinyItemTierTypeInfusionBlock; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -4482,7 +4677,7 @@ export interface IDestinyItemTierTypeDefinition { readonly redacted: boolean; } -export interface IDestinyItemTierTypeInfusionBlock { +export interface DestinyItemTierTypeInfusionBlock { /** * The default portion of quality that will transfer from the infuser to the * infusee item. (InfuserQuality - InfuseeQuality) * baseQualityTransferRatio = @@ -4514,12 +4709,12 @@ export const enum TierType { * Primarily for Quests, this is the definition of properties related to the item * if it is a quest and its various quest steps. */ -export interface IDestinyItemSetBlockDefinition { +export interface DestinyItemSetBlockDefinition { /** * A collection of hashes of set items, for items such as Quest Metadata items that * possess this data. */ - readonly itemList: IDestinyItemSetBlockEntryDefinition[]; + readonly itemList: DestinyItemSetBlockEntryDefinition[]; /** * If true, items in the set can only be added in increasing order, and adding an * item will remove any previous item. For Quests, this is by necessity true. Only @@ -4534,7 +4729,7 @@ export interface IDestinyItemSetBlockDefinition { } /** Defines a particular entry in an ItemSet (AKA a particular Quest Step in a Quest) */ -export interface IDestinyItemSetBlockEntryDefinition { +export interface DestinyItemSetBlockEntryDefinition { /** * Used for tracking which step a user reached. These values will be populated in * the user's internal state, which we expose externally as a more usable @@ -4546,7 +4741,7 @@ export interface IDestinyItemSetBlockEntryDefinition { * This is the hash identifier for a DestinyInventoryItemDefinition representing * this quest step. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly itemHash: number; } @@ -4569,7 +4764,7 @@ export interface IDestinyItemSetBlockEntryDefinition { * in BNet vs. how they appear in-game. This is a known limitation of our item * statistics, without any planned fix. */ -export interface IDestinyItemStatBlockDefinition { +export interface DestinyItemStatBlockDefinition { /** * If true, the game won't show the "primary" stat on this item when you inspect it. * @@ -4587,7 +4782,7 @@ export interface IDestinyItemStatBlockDefinition { * provided to you. But if you want to see how the sausage gets made, or perform * computations yourself, this is valuable information. * - * Mapped to IDestinyStatGroupDefinition in the manifest. + * Mapped to DestinyStatGroupDefinition in the manifest. */ readonly statGroupHash?: number; /** @@ -4600,9 +4795,9 @@ export interface IDestinyItemStatBlockDefinition { * These stats are keyed by the DestinyStatDefinition's hash identifier for the * stat that's found on the item. * - * Mapped to IDestinyStatDefinition in the manifest. + * Mapped to DestinyStatDefinition in the manifest. */ - readonly stats: { [key: number]: IDestinyInventoryItemStatDefinition }; + readonly stats: { [key: number]: DestinyInventoryItemStatDefinition }; /** * A quick and lazy way to determine whether any stat other than the "primary" stat * is actually visible on the item. Items often have stats that we return in case @@ -4619,7 +4814,7 @@ export interface IDestinyItemStatBlockDefinition { * stats.stats, and the renderable data for the primary stat in the related * DestinyStatDefinition. * - * Mapped to IDestinyStatDefinition in the manifest. + * Mapped to DestinyStatDefinition in the manifest. */ readonly primaryBaseStatHash: number; } @@ -4639,7 +4834,7 @@ export interface IDestinyItemStatBlockDefinition { * also accounts for certain stat modifiers that can't easily be accounted for * without live data (such as stat modifiers on Talent Grids and Socket Plugs) */ -export interface IDestinyStatGroupDefinition { +export interface DestinyStatGroupDefinition { /** * The maximum possible value that any stat in this group can be transformed into. * @@ -4663,7 +4858,7 @@ export interface IDestinyStatGroupDefinition { * In retrospect, I wouldn't mind if this was a dictionary keyed by the stat hash * instead. But I'm going to leave it be because [[After Apple Picking]]. */ - readonly scaledStats: IDestinyStatDisplayDefinition[]; + readonly scaledStats: DestinyStatDisplayDefinition[]; /** * The game has the ability to override, based on the stat group, what the * localized text is that is displayed for Stats being shown on the item. @@ -4672,7 +4867,7 @@ export interface IDestinyStatGroupDefinition { * we'll all need to start using them (and those of you who are more prudent than I * am can go ahead and start pre-checking for this.) */ - readonly overrides: { [key: number]: IDestinyStatOverrideDefinition }; + readonly overrides: { [key: number]: DestinyStatOverrideDefinition }; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -4699,14 +4894,14 @@ export interface IDestinyStatGroupDefinition { * This represents the transformation of a stat into a "Display" stat (the closest * value that BNet can get to the in-game display value of the stat) */ -export interface IDestinyStatDisplayDefinition { +export interface DestinyStatDisplayDefinition { /** * The hash identifier for the stat being transformed into a Display stat. * * Use it to look up the DestinyStatDefinition, or key into a * DestinyInventoryItemDefinition's stats property. * - * Mapped to IDestinyStatDefinition in the manifest. + * Mapped to DestinyStatDefinition in the manifest. */ readonly statHash: number; /** @@ -4727,7 +4922,7 @@ export interface IDestinyStatDisplayDefinition { * * See DestinyStatDefinition for a description of the stages of stat transformation. */ - readonly displayInterpolation: IInterpolationPoint[]; + readonly displayInterpolation: InterpolationPoint[]; } /** @@ -4748,18 +4943,18 @@ export interface IDestinyStatDisplayDefinition { * overriding Stat Group. Other items will still show the default stat's name/ * description. */ -export interface IDestinyStatOverrideDefinition { +export interface DestinyStatOverrideDefinition { /** * The hash identifier of the stat whose display properties are being overridden. * - * Mapped to IDestinyStatDefinition in the manifest. + * Mapped to DestinyStatDefinition in the manifest. */ readonly statHash: number; /** * The display properties to show instead of the base DestinyStatDefinition display * properties. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; } /** @@ -4770,11 +4965,11 @@ export interface IDestinyStatOverrideDefinition { * Not guaranteed to match real-world instances of the item, but should hopefully * at least be close. If it's not close, let us know on the Bungie API forums. */ -export interface IDestinyInventoryItemStatDefinition { +export interface DestinyInventoryItemStatDefinition { /** * The hash for the DestinyStatDefinition representing this stat. * - * Mapped to IDestinyStatDefinition in the manifest. + * Mapped to DestinyStatDefinition in the manifest. */ readonly statHash: number; /** @@ -4809,11 +5004,11 @@ export interface IDestinyInventoryItemStatDefinition { * Items that can be equipped define this block. It contains information we need to * understand how and when the item can be equipped. */ -export interface IDestinyEquippingBlockDefinition { +export interface DestinyEquippingBlockDefinition { /** * If the item is part of a gearset, this is a reference to that gearset item. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly gearsetItemHash?: number; /** @@ -4832,7 +5027,7 @@ export interface IDestinyEquippingBlockDefinition { * An equipped item *must* be equipped in an Equipment Slot. This is the hash * identifier of the DestinyEquipmentSlotDefinition into which it must be equipped. * - * Mapped to IDestinyEquipmentSlotDefinition in the manifest. + * Mapped to DestinyEquipmentSlotDefinition in the manifest. */ readonly equipmentSlotTypeHash: number; /** @@ -4840,6 +5035,9 @@ export interface IDestinyEquippingBlockDefinition { * * For now, this can only be "equip on acquire", which would mean that the item * will be automatically equipped as soon as you pick it up. + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. */ readonly attributes: EquippingItemBlockAttributes; /** @@ -4856,6 +5054,10 @@ export interface IDestinyEquippingBlockDefinition { readonly displayStrings: string[]; } +/** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum EquippingItemBlockAttributes { None = 0, EquipOnAcquire = 1 @@ -4870,22 +5072,22 @@ export const enum DestinyAmmunitionType { } /** This Block defines the rendering data associated with the item, if any. */ -export interface IDestinyItemTranslationBlockDefinition { +export interface DestinyItemTranslationBlockDefinition { readonly weaponPatternIdentifier: string; readonly weaponPatternHash: number; - readonly defaultDyes: IDyeReference[]; - readonly lockedDyes: IDyeReference[]; - readonly customDyes: IDyeReference[]; - readonly arrangements: IDestinyGearArtArrangementReference[]; + readonly defaultDyes: DyeReference[]; + readonly lockedDyes: DyeReference[]; + readonly customDyes: DyeReference[]; + readonly arrangements: DestinyGearArtArrangementReference[]; readonly hasGeometry: boolean; } -export interface IDyeReference { +export interface DyeReference { readonly channelHash: number; readonly dyeHash: number; } -export interface IDestinyGearArtArrangementReference { +export interface DestinyGearArtArrangementReference { readonly classHash: number; readonly artArrangementHash: number; } @@ -4896,7 +5098,7 @@ export interface IDestinyGearArtArrangementReference { * * This defines those categories, and gives some insights into that data's source. */ -export interface IDestinyItemPreviewBlockDefinition { +export interface DestinyItemPreviewBlockDefinition { /** * A string that the game UI uses as a hint for which detail screen to show for the * item. You, too, can leverage this for your own custom screen detail views. Note, @@ -4909,7 +5111,7 @@ export interface IDestinyItemPreviewBlockDefinition { * If the preview data is derived from a fake "Preview" Vendor, this will be the * hash identifier for the DestinyVendorDefinition of that fake vendor. * - * Mapped to IDestinyVendorDefinition in the manifest. + * Mapped to DestinyVendorDefinition in the manifest. */ readonly previewVendorHash: number; /** @@ -4921,7 +5123,7 @@ export interface IDestinyItemPreviewBlockDefinition { * This is a list of the items being previewed, categorized in the same way as they * are in the preview UI. */ - readonly derivedItemCategories: IDestinyDerivedItemCategoryDefinition[]; + readonly derivedItemCategories: DestinyDerivedItemCategoryDefinition[]; } /** @@ -4937,7 +5139,7 @@ export interface IDestinyItemPreviewBlockDefinition { * summarize that info here so that you don't have to do that Vendor lookup and * aggregation manually. */ -export interface IDestinyDerivedItemCategoryDefinition { +export interface DestinyDerivedItemCategoryDefinition { /** * The localized string for the category title. This will be something describing * the items you can get as a group, or your likelihood/the quantity you'll get. @@ -4947,7 +5149,7 @@ export interface IDestinyDerivedItemCategoryDefinition { * This is the list of all of the items for this category and the basic properties * we'll know about them. */ - readonly items: IDestinyDerivedItemDefinition[]; + readonly items: DestinyDerivedItemDefinition[]; } /** @@ -4956,7 +5158,7 @@ export interface IDestinyDerivedItemCategoryDefinition { * summary information for an Emote that you can get by opening an an Eververse Box) * See DestinyDerivedItemCategoryDefinition for more information. */ -export interface IDestinyDerivedItemDefinition { +export interface DestinyDerivedItemDefinition { /** * The hash for the DestinyInventoryItemDefinition of this derived item, if there * is one. Sometimes we are given this information as a manual override, in which @@ -4990,7 +5192,7 @@ export interface IDestinyDerivedItemDefinition { * provided here in case they are still useful for people. This also contains some * information about Infusion. */ -export interface IDestinyItemQualityBlockDefinition { +export interface DestinyItemQualityBlockDefinition { /** * The "base" defined level of an item. This is a list because, in theory, each * Expansion could define its own base level for an item. @@ -5034,7 +5236,7 @@ export interface IDestinyItemQualityBlockDefinition { * DestinyProgressionLevelRequirementDefinition, and you can use this hash to find * the appropriate definition. * - * Mapped to IDestinyProgressionLevelRequirementDefinition in the manifest. + * Mapped to DestinyProgressionLevelRequirementDefinition in the manifest. */ readonly progressionLevelRequirementHash: number; } @@ -5052,7 +5254,7 @@ export interface IDestinyItemQualityBlockDefinition { * interpolate a value in the requirementCurve property. The value picked up from * that interpolation will be the required level for the item. */ -export interface IDestinyProgressionLevelRequirementDefinition { +export interface DestinyProgressionLevelRequirementDefinition { /** * A curve of level requirements, weighted by the related progressions' level. * @@ -5060,14 +5262,14 @@ export interface IDestinyProgressionLevelRequirementDefinition { * determine what the level requirement of the generated item that is using this * data will be. */ - readonly requirementCurve: IInterpolationPointFloat[]; + readonly requirementCurve: InterpolationPointFloat[]; /** * The progression whose level should be used to determine the level requirement. * * Look up the DestinyProgressionDefinition with this hash for more information * about the progression in question. * - * Mapped to IDestinyProgressionDefinition in the manifest. + * Mapped to DestinyProgressionDefinition in the manifest. */ readonly progressionHash: number; /** @@ -5101,9 +5303,9 @@ export interface IDestinyProgressionLevelRequirementDefinition { * It will likely be used in a number of other ways in the future, it appears to be * a bucket where they put arbitrary items and quantities into the item. */ -export interface IDestinyItemValueBlockDefinition { +export interface DestinyItemValueBlockDefinition { /** References to the items that make up this item's "value", and the quantity. */ - readonly itemValue: IDestinyItemQuantity[]; + readonly itemValue: DestinyItemQuantity[]; /** * If there's a localized text description of the value provided, this will be said * description. @@ -5112,24 +5314,26 @@ export interface IDestinyItemValueBlockDefinition { } /** Data about an item's "sources": ways that the item can be obtained. */ -export interface IDestinyItemSourceBlockDefinition { +export interface DestinyItemSourceBlockDefinition { /** * The list of hash identifiers for Reward Sources that hint where the item can be * found (DestinyRewardSourceDefinition). * - * Mapped to IDestinyRewardSourceDefinition in the manifest. + * Mapped to DestinyRewardSourceDefinition in the manifest. */ readonly sourceHashes: number[]; /** * A collection of details about the stats that were computed for the ways we found * that the item could be spawned. */ - readonly sources: IDestinyItemSourceDefinition[]; + readonly sources: DestinyItemSourceDefinition[]; /** * If we found that this item is exclusive to a specific platform, this will be set * to the BungieMembershipType enumeration that matches that platform. */ readonly exclusive: BungieMembershipType; + /** A denormalized reference back to vendors that potentially sell this item. */ + readonly vendorSources: DestinyItemVendorSourceReference[]; } /** @@ -5149,8 +5353,8 @@ export interface IDestinyItemSourceBlockDefinition { * that item while playing Nightfall, either during play or as an after-completion * reward. */ -export interface IDestinyRewardSourceDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyRewardSourceDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * Sources are grouped into categories: common ways that items are provided. I hope * to see this expand in Destiny 2 once we have time to generate accurate reward @@ -5174,6 +5378,11 @@ export interface IDestinyRewardSourceDefinition { readonly redacted: boolean; } +/** + * BNet's custom categorization of reward sources. We took a look at the existing + * ways that items could be spawned, and tried to make high-level categorizations + * of them. This needs to be re-evaluated for Destiny 2. + */ export const enum DestinyRewardSourceCategory { /** The source doesn't fit well into any of the other types. */ None = 0, @@ -5202,7 +5411,7 @@ export const enum DestinyRewardSourceCategory { * Items will have many of these sources, one per level at which it spawns, to try * and give more granular data about where items spawn for specific level ranges. */ -export interface IDestinyItemSourceDefinition { +export interface DestinyItemSourceDefinition { /** * The level at which the item spawns. Essentially the Primary Key for this source * data: there will be multiple of these source entries per item that has source @@ -5231,15 +5440,43 @@ export interface IDestinyItemSourceDefinition { */ readonly maxLevelRequired: number; /** The stats computed for this level/quality range. */ - readonly computedStats: { [key: number]: IDestinyInventoryItemStatDefinition }; + readonly computedStats: { [key: number]: DestinyInventoryItemStatDefinition }; /** * The DestinyRewardSourceDefinitions found that can spawn the item at this level. * - * Mapped to IDestinyRewardSourceDefinition in the manifest. + * Mapped to DestinyRewardSourceDefinition in the manifest. */ readonly sourceHashes: number[]; } +/** + * Represents that a vendor could sell this item, and provides a quick link to that + * vendor and sale item. + * + * Note that we do not and cannot make a guarantee that the vendor will ever * + * actually* sell this item, only that the Vendor has a definition that indicates + * it *could* be sold. + * + * Note also that a vendor may sell the same item in multiple "ways", which means + * there may be multiple vendorItemIndexes for a single Vendor hash. + */ +export interface DestinyItemVendorSourceReference { + /** + * The identifier for the vendor that may sell this item. + * + * Mapped to DestinyVendorDefinition in the manifest. + */ + readonly vendorHash: number; + /** + * The Vendor sale item indexes that represent the sale information for this item. + * The same vendor may sell an item in multiple "ways", hence why this is a list. ( + * for instance, a weapon may be "sold" as a reward in a quest, for Glimmer, and + * for Masterwork Cores: each of those ways would be represented by a different + * vendor sale item with a different index) + */ + readonly vendorItemIndexes: number[]; +} + /** * An item can have objectives on it. In practice, these are the exclusive purview * of "Quest Step" items: DestinyInventoryItemDefinitions that represent a specific @@ -5248,12 +5485,12 @@ export interface IDestinyItemSourceDefinition { * Quest steps have 1:M objectives that we end up processing and returning in live * data as DestinyQuestStatus data, and other useful information. */ -export interface IDestinyItemObjectiveBlockDefinition { +export interface DestinyItemObjectiveBlockDefinition { /** * The hashes to Objectives (DestinyObjectiveDefinition) that are part of this * Quest Step, in the order that they should be rendered. * - * Mapped to IDestinyObjectiveDefinition in the manifest. + * Mapped to DestinyObjectiveDefinition in the manifest. */ readonly objectiveHashes: number[]; /** @@ -5265,7 +5502,7 @@ export interface IDestinyItemObjectiveBlockDefinition { * Rendered somewhat obsolete by perObjectiveDisplayProperties, which currently has * much the same information but may end up with more info in the future. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly displayActivityHashes: number[]; /** @@ -5277,7 +5514,7 @@ export interface IDestinyItemObjectiveBlockDefinition { * The hash for the DestinyInventoryItemDefinition representing the Quest to which * this Quest Step belongs. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly questlineItemHash: number; /** The localized string for narrative text related to this quest step, if any. */ @@ -5298,14 +5535,14 @@ export interface IDestinyItemObjectiveBlockDefinition { */ readonly questTypeHash: number; /** One entry per Objective on the item, it will have related display information. */ - readonly perObjectiveDisplayProperties: IDestinyObjectiveDisplayProperties[]; + readonly perObjectiveDisplayProperties: DestinyObjectiveDisplayProperties[]; } -export interface IDestinyObjectiveDisplayProperties { +export interface DestinyObjectiveDisplayProperties { /** * The activity associated with this objective in the context of this item, if any. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly activityHash?: number; /** If true, the game shows this objective on item preview screens. */ @@ -5321,7 +5558,7 @@ export interface IDestinyObjectiveDisplayProperties { * DestinySocketTypeDefinition for information about Plug Categories and socket * compatibility), whether it is enabled and other Plug info. */ -export interface IDestinyItemPlugDefinition { +export interface DestinyItemPlugDefinition { /** * The rules around when this plug can be inserted into a socket, aside from the * socket's individual restrictions. @@ -5329,7 +5566,7 @@ export interface IDestinyItemPlugDefinition { * The live data DestinyItemPlugComponent.insertFailIndexes will be an index into * this array, so you can pull out the failure strings appropriate for the user. */ - readonly insertionRules: IDestinyPlugRuleDefinition[]; + readonly insertionRules: DestinyPlugRuleDefinition[]; /** * The string identifier for the plug's category. Use the socket's * DestinySocketTypeDefinition.plugWhitelist to determine whether this plug can be @@ -5350,7 +5587,7 @@ export interface IDestinyItemPlugDefinition { * If inserting this plug requires materials, this is the hash identifier for * looking up the DestinyMaterialRequirementSetDefinition for those requirements. * - * Mapped to IDestinyMaterialRequirementSetDefinition in the manifest. + * Mapped to DestinyMaterialRequirementSetDefinition in the manifest. */ readonly insertionMaterialRequirementHash: number; /** @@ -5358,7 +5595,7 @@ export interface IDestinyItemPlugDefinition { * shown with the plug attached. Look up the DestinyInventoryItemDefinition for * this hash for the item. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly previewItemOverrideHash: number; /** @@ -5366,7 +5603,7 @@ export interface IDestinyItemPlugDefinition { * it to be enabled, it may require materials. This is the hash identifier for the * DestinyMaterialRequirementSetDefinition for those requirements, if there is one. * - * Mapped to IDestinyMaterialRequirementSetDefinition in the manifest. + * Mapped to DestinyMaterialRequirementSetDefinition in the manifest. */ readonly enabledMaterialRequirementHash: number; /** @@ -5376,7 +5613,7 @@ export interface IDestinyItemPlugDefinition { * The live data DestinyItemPlugComponent.enableFailIndexes will be an index into * this array, so you can pull out the failure strings appropriate for the user. */ - readonly enabledRules: IDestinyPlugRuleDefinition[]; + readonly enabledRules: DestinyPlugRuleDefinition[]; /** * Plugs can have arbitrary, UI-defined identifiers that the UI designers use to * determine the style applied to plugs. Unfortunately, we have neither a @@ -5388,6 +5625,10 @@ export interface IDestinyItemPlugDefinition { * do what we do, and just show plugs more generically, without specialized styles. */ readonly uiPlugLabel: string; + /** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ readonly plugStyle: PlugUiStyles; /** * If TRUE, the plug doesn't actually convey any benefit: it only exists to show @@ -5409,6 +5650,9 @@ export interface IDestinyItemPlugDefinition { * The alternate plug of the plug: only applies when the item is in states that * only the server can know about and control, unfortunately. See * AlternateUiPlugLabel for the related label info. + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. */ readonly alternatePlugStyle: PlugUiStyles; /** @@ -5426,7 +5670,7 @@ export interface IDestinyItemPlugDefinition { * If this is populated, it will have the override data to be applied when this * plug is applied to an item. */ - readonly parentItemOverride: IDestinyParentItemOverride; + readonly parentItemOverride: DestinyParentItemOverride; } /** @@ -5436,23 +5680,44 @@ export interface IDestinyItemPlugDefinition { * then look up that index in the appropriate property (enabledRules or * insertionRules) to get the localized string for the failure message if it failed. */ -export interface IDestinyPlugRuleDefinition { +export interface DestinyPlugRuleDefinition { /** The localized string to show if this rule fails. */ readonly failureMessage: string; } +/** + * If the plug has a specific custom style, this enumeration will represent that + * style/those styles. + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum PlugUiStyles { None = 0, Masterwork = 1 } +/** + * This enum determines whether the plug is available to be inserted. + * + * - Normal means that all existing rules for plug insertion apply. + * + * - UnavailableIfSocketContainsMatchingPlugCategory means that the plug is only + * available if the socket does NOT match the plug category. + * + * - AvailableIfSocketContainsMatchingPlugCategory means that the plug is only + * available if the socket DOES match the plug category. + * + * For category matching, use the plug's "plugCategoryIdentifier" property, + * comparing it to + */ export const enum PlugAvailabilityMode { Normal = 0, UnavailableIfSocketContainsMatchingPlugCategory = 1, AvailableIfSocketContainsMatchingPlugCategory = 2 } -export interface IDestinyParentItemOverride { +export interface DestinyParentItemOverride { readonly additionalEquipRequirementsDisplayStrings: string[]; readonly pipIcon: string; } @@ -5462,14 +5727,14 @@ export interface IDestinyParentItemOverride { * unlock expression that evaluates to a number representing the progress toward * gearset completion (a very rare use for unlock expressions!) */ -export interface IDestinyItemGearsetBlockDefinition { +export interface DestinyItemGearsetBlockDefinition { /** The maximum possible number of items that can be collected. */ readonly trackingValueMax: number; /** * The list of hashes for items in the gearset. Use them to look up * DestinyInventoryItemDefinition entries for the items in the set. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly itemList: number[]; } @@ -5479,7 +5744,7 @@ export interface IDestinyItemGearsetBlockDefinition { * information related to its sack status, mostly UI strings. Engrams are an * example of items that are considered to be "Sacks". */ -export interface IDestinyItemSackBlockDefinition { +export interface DestinyItemSackBlockDefinition { /** * A description of what will happen when you open the sack. As far as I can tell, * this is blank currently. Unknown whether it will eventually be populated with @@ -5494,7 +5759,7 @@ export interface IDestinyItemSackBlockDefinition { } /** If defined, the item has at least one socket. */ -export interface IDestinyItemSocketBlockDefinition { +export interface DestinyItemSocketBlockDefinition { /** * This was supposed to be a string that would give per-item details about sockets. * In practice, it turns out that all this ever has is the localized word "details". @@ -5505,32 +5770,32 @@ export interface IDestinyItemSocketBlockDefinition { * Each non-intrinsic (or mutable) socket on an item is defined here. Check inside * for more info. */ - readonly socketEntries: IDestinyItemSocketEntryDefinition[]; + readonly socketEntries: DestinyItemSocketEntryDefinition[]; /** * Each intrinsic (or immutable/permanent) socket on an item is defined here, along * with the plug that is permanently affixed to the socket. */ - readonly intrinsicSockets: IDestinyItemIntrinsicSocketEntryDefinition[]; + readonly intrinsicSockets: DestinyItemIntrinsicSocketEntryDefinition[]; /** * A convenience property, that refers to the sockets in the "sockets" property, * pre-grouped by category and ordered in the manner that they should be grouped in * the UI. You could form this yourself with the existing data, but why would you * want to? Enjoy life man. */ - readonly socketCategories: IDestinyItemSocketCategoryDefinition[]; + readonly socketCategories: DestinyItemSocketCategoryDefinition[]; } /** * The definition information for a specific socket on an item. This will determine * how the socket behaves in-game. */ -export interface IDestinyItemSocketEntryDefinition { +export interface DestinyItemSocketEntryDefinition { /** * All sockets have a type, and this is the hash identifier for this particular * type. Use it to look up the DestinySocketTypeDefinition: read there for more * information on how socket types affect the behavior of the socket. * - * Mapped to IDestinySocketTypeDefinition in the manifest. + * Mapped to DestinySocketTypeDefinition in the manifest. */ readonly socketTypeHash: number; /** @@ -5539,7 +5804,7 @@ export interface IDestinyItemSocketEntryDefinition { * inserted into the item on item creation. Otherwise, this Socket will either * start without a plug inserted, or will have one randomly inserted. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly singleInitialItemHash: number; /** @@ -5549,7 +5814,7 @@ export interface IDestinyItemSocketEntryDefinition { * If this list is populated, you will not be allowed to plug an arbitrary item in * the socket: you will only be able to choose from one of these reusable plugs. */ - readonly reusablePlugItems: IDestinyItemSocketEntryPlugItemDefinition[]; + readonly reusablePlugItems: DestinyItemSocketEntryPlugItemDefinition[]; /** * If this is true, then the socket will not be initialized with a plug if the item * is purchased from a Vendor. @@ -5570,6 +5835,9 @@ export interface IDestinyItemSocketEntryDefinition { * you populate your UI, as well as what plugs are valid for this socket. It's an * alternative to having to check for the existence of certain properties ( * reusablePlugItems for example) to infer where plugs should come from. + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. */ readonly plugSources: SocketPlugSources; /** @@ -5584,7 +5852,7 @@ export interface IDestinyItemSocketEntryDefinition { * the live data will return a subset of plugs from this list that are active and * able to be inserted into the socket just like a reusable plug. */ - readonly randomizedPlugItems: IDestinyItemSocketEntryPlugItemRandomizedDefinition[]; + readonly randomizedPlugItems: DestinyItemSocketEntryPlugItemRandomizedDefinition[]; /** * If true, then this socket is visible in the item's "default" state. If you have * an instance, you should always check the runtime state, as that can override @@ -5597,16 +5865,24 @@ export interface IDestinyItemSocketEntryDefinition { } /** The definition of a known, reusable plug that can be applied to a socket. */ -export interface IDestinyItemSocketEntryPlugItemDefinition { +export interface DestinyItemSocketEntryPlugItemDefinition { /** * The hash identifier of a DestinyInventoryItemDefinition representing the plug * that can be inserted. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly plugItemHash: number; } +/** + * Indicates how a socket is populated, and where you should look for valid plug + * data. This is a flags enumeration/bitmask field, as you may have to look in + * multiple sources across multiple components for valid plugs. + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum SocketPlugSources { /** If there's no way we can detect to insert new plugs. */ None = 0, @@ -5635,12 +5911,12 @@ export const enum SocketPlugSources { CharacterPlugSet = 8 } -export interface IDestinyItemSocketEntryPlugItemRandomizedDefinition { +export interface DestinyItemSocketEntryPlugItemRandomizedDefinition { /** * The hash identifier of a DestinyInventoryItemDefinition representing the plug * that can be inserted. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly plugItemHash: number; } @@ -5650,17 +5926,17 @@ export interface IDestinyItemSocketEntryPlugItemRandomizedDefinition { * useful for situations where the weapon needs to have a visual plug/Mod on it, * but that plug/Mod should never change. */ -export interface IDestinyItemIntrinsicSocketEntryDefinition { +export interface DestinyItemIntrinsicSocketEntryDefinition { /** * Indicates the plug that is intrinsically inserted into this socket. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly plugItemHash: number; /** * Indicates the type of this intrinsic socket. * - * Mapped to IDestinySocketTypeDefinition in the manifest. + * Mapped to DestinySocketTypeDefinition in the manifest. */ readonly socketTypeHash: number; /** @@ -5678,13 +5954,13 @@ export interface IDestinyItemIntrinsicSocketEntryDefinition { * Sockets are grouped into categories in the UI. These define which category and * which sockets are under that category. */ -export interface IDestinyItemSocketCategoryDefinition { +export interface DestinyItemSocketCategoryDefinition { /** * The hash for the Socket Category: a quick way to go get the header display * information for the category. Use it to look up DestinySocketCategoryDefinition * info. * - * Mapped to IDestinySocketCategoryDefinition in the manifest. + * Mapped to DestinySocketCategoryDefinition in the manifest. */ readonly socketCategoryHash: number; /** @@ -5699,7 +5975,7 @@ export interface IDestinyItemSocketCategoryDefinition { * This appears to be information used when rendering rewards. We don't currently * use it on BNet. */ -export interface IDestinyItemSummaryBlockDefinition { +export interface DestinyItemSummaryBlockDefinition { /** * Apparently when rendering an item in a reward, this should be used as a sort * priority. We're not doing it presently. @@ -5715,11 +5991,11 @@ export interface IDestinyItemSummaryBlockDefinition { * Builds/Subclasses are the only items left that still have talent grids with * meaningful Nodes. */ -export interface IDestinyItemTalentGridBlockDefinition { +export interface DestinyItemTalentGridBlockDefinition { /** * The hash identifier of the DestinyTalentGridDefinition attached to this item. * - * Mapped to IDestinyTalentGridDefinition in the manifest. + * Mapped to DestinyTalentGridDefinition in the manifest. */ readonly talentGridHash: number; /** @@ -5787,7 +6063,7 @@ export interface IDestinyItemTalentGridBlockDefinition { * with the instanced data to give the user the visual representation of their item' * s talent grid. */ -export interface IDestinyTalentGridDefinition { +export interface DestinyTalentGridDefinition { /** * The maximum possible level of the Talent Grid: at this level, any nodes are * allowed to be activated. @@ -5809,7 +6085,7 @@ export interface IDestinyTalentGridDefinition { * it will cross the threshold where nodes can be activated. See * DestinyTalentGridStepDefinition's activation requirements for more information. * - * Mapped to IDestinyProgressionDefinition in the manifest. + * Mapped to DestinyProgressionDefinition in the manifest. */ readonly progressionHash: number; /** @@ -5818,7 +6094,7 @@ export interface IDestinyTalentGridDefinition { * know the current step for a node by retrieving instanced data through platform * calls to the API that return DestinyItemTalentGridComponent). */ - readonly nodes: IDestinyTalentNodeDefinition[]; + readonly nodes: DestinyTalentNodeDefinition[]; /** * Talent Nodes can exist in "exclusive sets": these are sets of nodes in which * only a single node in the set can be activated at any given time. Activating a @@ -5834,7 +6110,7 @@ export interface IDestinyTalentGridDefinition { * by that? Jeez) See the groups property for information about that only- * tangentially-related concept. */ - readonly exclusiveSets: IDestinyTalentNodeExclusiveSetDefinition[]; + readonly exclusiveSets: DestinyTalentNodeExclusiveSetDefinition[]; /** * This is a quick reference to the indexes of nodes that are not part of exclusive * sets. Handy for knowing which talent nodes can only be activated directly, @@ -5849,7 +6125,7 @@ export interface IDestinyTalentGridDefinition { * how they work. These groups are keyed by the "groupHash" from * DestinyTalentExclusiveGroup. */ - readonly groups: { [key: number]: IDestinyTalentExclusiveGroup }; + readonly groups: { [key: number]: DestinyTalentExclusiveGroup }; /** * BNet wants to show talent nodes grouped by similar purpose with localized titles. * This is the ordered list of those categories: if you want to show nodes by @@ -5862,7 +6138,7 @@ export interface IDestinyTalentGridDefinition { * groups. These are purely for visual grouping of nodes rather than functional * grouping. */ - readonly nodeCategories: IDestinyTalentNodeCategory[]; + readonly nodeCategories: DestinyTalentNodeCategory[]; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -5891,7 +6167,7 @@ export interface IDestinyTalentGridDefinition { * See DestinyTalentGridDefinition for a more complete overview of how Talent Grids * work, and how they are used in Destiny 2 (and how they were used in Destiny 1). */ -export interface IDestinyTalentNodeDefinition { +export interface DestinyTalentNodeDefinition { /** * The index into the DestinyTalentGridDefinition's "nodes" property where this * node is located. Used to uniquely identify the node within the Talent Grid. Note @@ -5968,7 +6244,7 @@ export interface IDestinyTalentNodeDefinition { * The system still exists to do this, as far as I know, so it may yet come back * around! */ - readonly randomActivationRequirement: IDestinyNodeActivationRequirement; + readonly randomActivationRequirement: DestinyNodeActivationRequirement; /** * If this is true, the node can be "re-rolled" to acquire a different random * current step. This is not used, but still exists for a theoretical future of @@ -5983,7 +6259,7 @@ export interface IDestinyTalentNodeDefinition { * logic when processing Vendor data - you'll have to use the "realSteps" property * below. */ - readonly steps: IDestinyNodeStepDefinition[]; + readonly steps: DestinyNodeStepDefinition[]; /** * The nodeHash values for nodes that are in an Exclusive Set with this node. * @@ -6020,7 +6296,7 @@ export interface IDestinyTalentNodeDefinition { * tooltip. This is the hash identifier of the lore element to show, if there is * one to be show. * - * Mapped to IDestinyLoreDefinition in the manifest. + * Mapped to DestinyLoreDefinition in the manifest. */ readonly loreHash?: number; /** @@ -6042,7 +6318,7 @@ export interface IDestinyTalentNodeDefinition { * required, and other conditional information that limits whether a talent node * can be activated. */ -export interface IDestinyNodeActivationRequirement { +export interface DestinyNodeActivationRequirement { /** * The Progression level on the Talent Grid required to activate this node. * @@ -6061,7 +6337,7 @@ export interface IDestinyNodeActivationRequirement { * chosen from this list, and we won't know which one will be chosen until an * instance of the item is created. * - * Mapped to IDestinyMaterialRequirementSetDefinition in the manifest. + * Mapped to DestinyMaterialRequirementSetDefinition in the manifest. */ readonly materialRequirementHashes: number[]; } @@ -6084,12 +6360,12 @@ export interface IDestinyNodeActivationRequirement { * identifying the step within a node - are both content version dependent, and * thus are subject to change between content updates. */ -export interface IDestinyNodeStepDefinition { +export interface DestinyNodeStepDefinition { /** * These are the display properties actually used to render the Talent Node. The * currently active step's displayProperties are shown. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * The index of this step in the list of Steps on the Talent Node. * @@ -6116,7 +6392,7 @@ export interface IDestinyNodeStepDefinition { * If the step provides a damage type, this will be the hash identifier used to * look up the damage type's DestinyDamageTypeDefinition. * - * Mapped to IDestinyDamageTypeDefinition in the manifest. + * Mapped to DestinyDamageTypeDefinition in the manifest. */ readonly damageTypeHash?: number; /** @@ -6124,7 +6400,7 @@ export interface IDestinyNodeStepDefinition { * else than for the Talent Grid's Progression to have reached a certain level), * they will be defined here. */ - readonly activationRequirement: IDestinyNodeActivationRequirement; + readonly activationRequirement: DestinyNodeActivationRequirement; /** * There was a time when talent nodes could be activated multiple times, and the * effects of subsequent Steps would be compounded on each other, essentially " @@ -6155,7 +6431,7 @@ export interface IDestinyNodeStepDefinition { * applied when this step is active. Perks provide a variety of benefits and * modifications - examine DestinySandboxPerkDefinition to learn more. * - * Mapped to IDestinySandboxPerkDefinition in the manifest. + * Mapped to DestinySandboxPerkDefinition in the manifest. */ readonly perkHashes: number[]; /** @@ -6172,7 +6448,7 @@ export interface IDestinyNodeStepDefinition { * When the step provides stat benefits on the item or character, this is the list * of hash identifiers for stats (DestinyStatDefinition) that are provided. * - * Mapped to IDestinyStatDefinition in the manifest. + * Mapped to DestinyStatDefinition in the manifest. */ readonly statHashes: number[]; /** @@ -6189,7 +6465,7 @@ export interface IDestinyNodeStepDefinition { * Armory will need to account for Sockets rather than Talent Nodes, this * categorization capability feels useful enough to still keep around. */ - readonly stepGroups: IDestinyTalentNodeStepGroups; + readonly stepGroups: DestinyTalentNodeStepGroups; /** * If true, this step can affect the level of the item. See * DestinyInventoryItemDefintion for more information about item levels and their @@ -6201,16 +6477,16 @@ export interface IDestinyNodeStepDefinition { * socket items with new Plugs. See DestinyInventoryItemDefinition for more * information about sockets and plugs. */ - readonly socketReplacements: IDestinyNodeSocketReplaceResponse[]; + readonly socketReplacements: DestinyNodeSocketReplaceResponse[]; } /** * All damage types that are possible in the game are defined here, along with * localized info and icons as needed. */ -export interface IDestinyDamageTypeDefinition { +export interface DestinyDamageTypeDefinition { /** The description of the damage type, icon etc... */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** A variant of the icon that is transparent and colorless. */ readonly transparentIconPath: string; /** @@ -6246,19 +6522,19 @@ export interface IDestinyDamageTypeDefinition { * on the item that has a type matching the given socket type, inserting the * indicated plug item. */ -export interface IDestinyNodeSocketReplaceResponse { +export interface DestinyNodeSocketReplaceResponse { /** * The hash identifier of the socket type to find amidst the item's sockets (the * item to which this talent grid is attached). See DestinyInventoryItemDefinition. * sockets.socketEntries to find the socket type of sockets on the item in question. * - * Mapped to IDestinySocketTypeDefinition in the manifest. + * Mapped to DestinySocketTypeDefinition in the manifest. */ readonly socketTypeHash: number; /** * The hash identifier of the plug item that will be inserted into the socket found. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly plugItemHash: number; } @@ -6267,7 +6543,7 @@ export interface IDestinyNodeSocketReplaceResponse { * The list of indexes into the Talent Grid's "nodes" property for nodes in this * exclusive set. (See DestinyTalentNodeDefinition.nodeIndex) */ -export interface IDestinyTalentNodeExclusiveSetDefinition { +export interface DestinyTalentNodeExclusiveSetDefinition { /** * The list of node indexes for the exclusive set. Historically, these were indexes. * I would have liked to replace this with nodeHashes for consistency, but it's @@ -6283,7 +6559,7 @@ export interface IDestinyTalentNodeExclusiveSetDefinition { * in groups that are not allowed to be activated at the same time as this group) * to deactivate. */ -export interface IDestinyTalentExclusiveGroup { +export interface DestinyTalentExclusiveGroup { /** * The identifier for this exclusive group. Only guaranteed unique within the * talent grid, not globally. @@ -6293,7 +6569,7 @@ export interface IDestinyTalentExclusiveGroup { * If this group has an associated piece of lore to show next to it, this will be * the identifier for that DestinyLoreDefinition. * - * Mapped to IDestinyLoreDefinition in the manifest. + * Mapped to DestinyLoreDefinition in the manifest. */ readonly loreHash?: number; /** @@ -6321,7 +6597,7 @@ export interface IDestinyTalentExclusiveGroup { * This is a single set of references to Talent Nodes that share a common trait or * purpose. */ -export interface IDestinyTalentNodeCategory { +export interface DestinyTalentNodeCategory { /** * Mostly just for debug purposes, but if you find it useful you can have it. This * is BNet's manually created identifier for this category. @@ -6338,7 +6614,7 @@ export interface IDestinyTalentNodeCategory { * will likely not have description and an icon yet, but I'm going to keep my * options open. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * The set of all hash identifiers for Talent Nodes (DestinyTalentNodeDefinition) * in this Talent Grid that are part of this Category. @@ -6347,7 +6623,7 @@ export interface IDestinyTalentNodeCategory { } /** An intrinsic perk on an item, and the requirements for it to be activated. */ -export interface IDestinyItemPerkEntryDefinition { +export interface DestinyItemPerkEntryDefinition { /** * If this perk is not active, this is the string to show for why it's not * providing its benefits. @@ -6357,20 +6633,25 @@ export interface IDestinyItemPerkEntryDefinition { * A hash identifier for the DestinySandboxPerkDefinition being provided on the * item. * - * Mapped to IDestinySandboxPerkDefinition in the manifest. + * Mapped to DestinySandboxPerkDefinition in the manifest. */ readonly perkHash: number; /** Indicates whether this perk should be shown, or if it should be shown disabled. */ readonly perkVisibility: ItemPerkVisibility; } +/** + * Indicates how a perk should be shown, or if it should be, in the game UI. Maybe + * useful for those of you trying to filter out internal-use-only perks (or for + * those of you trying to figure out what they do!) + */ export const enum ItemPerkVisibility { Visible = 0, Disabled = 1, Hidden = 2 } -export interface IDestinyAnimationReference { +export interface DestinyAnimationReference { readonly animName: string; readonly animIdentifier: string; readonly path: string; @@ -6391,8 +6672,8 @@ export interface IDestinyAnimationReference { * provide your own custom item filtering, sorting, aggregating... go nuts on it! * And let us know if you see more categories that you wish would be added! */ -export interface IDestinyItemCategoryDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyItemCategoryDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * If True, this category should be visible in UI. Sometimes we make categories * that we don't think are interesting externally. It's up to you if you want to @@ -6462,7 +6743,7 @@ export interface IDestinyItemCategoryDefinition { * * (I hope someone named Carl reads this someday) * - * Mapped to IDestinyItemCategoryDefinition in the manifest. + * Mapped to DestinyItemCategoryDefinition in the manifest. */ readonly groupedCategoryHashes: number[]; /** @@ -6494,6 +6775,26 @@ export interface IDestinyItemCategoryDefinition { readonly redacted: boolean; } +/** + * An enumeration that indicates the high-level "type" of the item, attempting to + * iron out the context specific differences for specific instances of an entity. + * For instance, though a weapon may be of various weapon "Types", in + * DestinyItemType they are all classified as "Weapon". This allows for better + * filtering on a higher level of abstraction for the concept of types. + * + * This enum is provided for historical compatibility with Destiny 1, but an ideal + * alternative is to use DestinyItemCategoryDefinitions and the + * DestinyItemDefinition.itemCategories property instead. Item Categories allow for + * arbitrary hierarchies of specificity, and for items to belong to multiple + * categories across multiple hierarchies simultaneously. For this enum, we pick a + * single type as a "best guess" fit. + * + * NOTE: This is not all of the item types available, and some of these are + * holdovers from Destiny 1 that may or may not still exist. + * + * I keep updating these because they're so damn convenient. I guess I shouldn't + * fight it. + */ export const enum DestinyItemType { None = 0, Currency = 1, @@ -6528,6 +6829,14 @@ export const enum DestinyClass { Unknown = 3 } +/** + * As you run into items that need to be classified for Milestone purposes in ways + * that we cannot infer via direct data, add a new classification here and use a + * string constant to represent it in the local item config file. + * + * NOTE: This is not all of the item types available, and some of these are + * holdovers from Destiny 1 that may or may not still exist. + */ export const enum SpecialItemType { None = 0, SpecialCurrency = 1, @@ -6540,6 +6849,16 @@ export const enum SpecialItemType { Currency = 29 } +/** + * Represents the possible components that can be returned from Destiny "Get" calls + * such as GetProfile, GetCharacter, GetVendor etc... + * + * When making one of these requests, you will pass one or more of these components + * as a comma separated list in the "?components=" querystring parameter. For + * instance, if you want baseline Profile data, Character Data, and character + * progressions, you would pass "?components=Profiles,Characters, + * CharacterProgressions" You may use either the numerical or string values. + */ export const enum DestinyComponentType { None = 0, /** @@ -6711,7 +7030,7 @@ export const enum DestinyComponentType { Records = 900 } -export interface IDestinyItemTransferRequest { +export interface DestinyItemTransferRequest { readonly itemReferenceHash: number; readonly stackSize: number; readonly transferToVault: boolean; @@ -6720,7 +7039,7 @@ export interface IDestinyItemTransferRequest { readonly membershipType: BungieMembershipType; } -export interface IDestinyPostmasterTransferRequest { +export interface DestinyPostmasterTransferRequest { readonly itemReferenceHash: number; readonly stackSize: number; readonly itemId: string; @@ -6728,26 +7047,26 @@ export interface IDestinyPostmasterTransferRequest { readonly membershipType: BungieMembershipType; } -export interface IDestinyItemActionRequest { +export interface DestinyItemActionRequest { readonly itemId: string; readonly characterId: string; readonly membershipType: BungieMembershipType; } -export interface IDestinyItemSetActionRequest { +export interface DestinyItemSetActionRequest { readonly itemIds: string[]; readonly characterId: string; readonly membershipType: BungieMembershipType; } -export interface IDestinyItemStateRequest { +export interface DestinyItemStateRequest { readonly state: boolean; readonly itemId: string; readonly characterId: string; readonly membershipType: BungieMembershipType; } -export interface IDestinyInsertPlugsActionRequest { +export interface DestinyInsertPlugsActionRequest { /** Action token provided by the AwaGetActionToken API call. */ readonly actionToken: string; /** @@ -6756,7 +7075,7 @@ export interface IDestinyInsertPlugsActionRequest { */ readonly itemInstanceId: string; /** The plugs being inserted. */ - readonly plug: IDestinyInsertPlugsRequestEntry; + readonly plug: DestinyInsertPlugsRequestEntry; readonly characterId: string; readonly membershipType: BungieMembershipType; } @@ -6775,14 +7094,14 @@ export interface IDestinyInsertPlugsActionRequest { * information and the PGCR ID that you pass into the URL of the reporting endpoint * itself. */ -export interface IDestinyReportOffensePgcrRequest { +export interface DestinyReportOffensePgcrRequest { /** * So you've decided to report someone instead of cursing them and their * descendants. Well, okay then. This is the category or categorie(s) of * infractions for which you are reporting the user. These are hash identifiers * that map to DestinyReportReasonCategoryDefinition entries. * - * Mapped to IDestinyReportReasonCategoryDefinition in the manifest. + * Mapped to DestinyReportReasonCategoryDefinition in the manifest. */ readonly reasonCategoryHashes: number[]; /** @@ -6800,6 +7119,11 @@ export interface IDestinyReportOffensePgcrRequest { readonly offendingCharacterId: string; } +/** + * If the enum value is > 100, it is a "special" group that cannot be queried for + * directly (special cases apply to when they are returned, and are not relevant in + * general cases) + */ export const enum DestinyStatsGroupType { None = 0, General = 1, @@ -6827,7 +7151,7 @@ export const enum PeriodType { Activity = 3 } -export interface IAwaPermissionRequested { +export interface AwaPermissionRequested { /** Type of advanced write action. */ readonly type: AwaType; /** @@ -6842,7 +7166,7 @@ export interface IAwaPermissionRequested { readonly characterId?: string; } -export interface IAwaUserResponse { +export interface AwaUserResponse { /** Indication of the selection the user has made (Approving or rejecting the action) */ readonly selection: AwaUserSelection; /** Correlation ID of the request */ @@ -6855,23 +7179,39 @@ export interface IAwaUserResponse { * DestinyManifest is the external-facing contract for just the properties needed * by those calling the Destiny Platform. */ -export interface IDestinyManifest { +export interface DestinyManifest { readonly version: string; readonly mobileAssetContentPath: string; - readonly mobileGearAssetDataBases: IGearAssetDataBaseDefinition[]; + readonly mobileGearAssetDataBases: GearAssetDataBaseDefinition[]; readonly mobileWorldContentPaths: { [key: string]: string }; readonly jsonWorldContentPaths: { [key: string]: string }; readonly mobileClanBannerDatabasePath: string; readonly mobileGearCDN: { [key: string]: string }; + /** + * Information about the "Image Pyramid" for Destiny icons. Where possible, we + * create smaller versions of Destiny icons. These are found as subfolders under + * the location of the "original/full size" Destiny images, with the same file name + * and extension as the original image itself. (this lets us avoid sending largely + * redundant path info with every entity, at the expense of the smaller versions of + * the image being less discoverable) + */ + readonly iconImagePyramidInfo: ImagePyramidEntry[]; } -export interface IGearAssetDataBaseDefinition { +export interface GearAssetDataBaseDefinition { readonly version: number; readonly path: string; } +export interface ImagePyramidEntry { + /** The name of the subfolder where these images are located. */ + readonly name: string; + /** The factor by which the original image size has been reduced. */ + readonly factor: number; +} + /** Provides common properties for destiny definitions. */ -export interface IDestinyDefinition { +export interface DestinyDefinition { /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -6896,14 +7236,14 @@ export interface IDestinyDefinition { * linked through your Bungie.Net account. We will not return accounts in this * response whose */ -export interface IDestinyLinkedProfilesResponse { +export interface DestinyLinkedProfilesResponse { /** * Any Destiny account for whom we could successfully pull characters will be * returned here, as the Platform-level summary of user data. (no character data, * no Destiny account data other than the Membership ID and Type so you can make * further queries) */ - readonly profiles: IDestinyProfileUserInfoCard[]; + readonly profiles: DestinyProfileUserInfoCard[]; /** * If the requested membership had a linked Bungie.Net membership ID, this is the * basic information about that BNet account. @@ -6912,16 +7252,16 @@ export interface IDestinyLinkedProfilesResponse { * concerns. But it's so damn convenient! https://www.youtube.com/watch?v=X5R-bB- * gKVI */ - readonly bnetMembership: IUserInfoCard; + readonly bnetMembership: UserInfoCard; /** * This is brief summary info for profiles that we believe have valid Destiny info, * but who failed to return data for some other reason and thus we know that * subsequent calls for their info will also fail. */ - readonly profilesWithErrors: IDestinyErrorProfile[]; + readonly profilesWithErrors: DestinyErrorProfile[]; } -export interface IDestinyProfileUserInfoCard { +export interface DestinyProfileUserInfoCard { readonly dateLastPlayed: string; /** * A platform specific additional display name - ex: psn Real Name, bnet Unique @@ -6949,7 +7289,7 @@ export interface IDestinyProfileUserInfoCard { * Assume that the most you'll get is the Error Code, the Membership Type and the * Membership ID. */ -export interface IDestinyErrorProfile { +export interface DestinyErrorProfile { /** * The error that we encountered. You should be able to look up localized text to * show to the user for these failures. @@ -6959,39 +7299,39 @@ export interface IDestinyErrorProfile { * Basic info about the account that failed. Don't expect anything other than * membership ID, Membership Type, and displayName to be populated. */ - readonly infoCard: IUserInfoCard; + readonly infoCard: UserInfoCard; } /** * The response for GetDestinyProfile, with components for character and item-level * data. */ -export interface IDestinyProfileResponse { +export interface DestinyProfileResponse { /** * Recent, refundable purchases you have made from vendors. When will you use it? * Couldn't say... * * COMPONENT TYPE: VendorReceipts */ - readonly vendorReceipts: ISingleComponentResponse; + readonly vendorReceipts: SingleComponentResponse; /** * The profile-level inventory of the Destiny Profile. * * COMPONENT TYPE: ProfileInventories */ - readonly profileInventory: ISingleComponentResponse; + readonly profileInventory: SingleComponentResponse; /** * The profile-level currencies owned by the Destiny Profile. * * COMPONENT TYPE: ProfileCurrencies */ - readonly profileCurrencies: ISingleComponentResponse; + readonly profileCurrencies: SingleComponentResponse; /** * The basic information about the Destiny Profile (formerly "Account"). * * COMPONENT TYPE: Profiles */ - readonly profile: ISingleComponentResponse; + readonly profile: SingleComponentResponse; /** * Items available from Kiosks that are available Profile-wide (i.e. across all * characters) @@ -7003,7 +7343,7 @@ export interface IDestinyProfileResponse { * * COMPONENT TYPE: Kiosks */ - readonly profileKiosks: ISingleComponentResponse; + readonly profileKiosks: SingleComponentResponse; /** * When sockets refer to reusable Plug Sets (see DestinyPlugSetDefinition for more * info), this is the set of plugs and their states that are profile-scoped. @@ -7013,7 +7353,7 @@ export interface IDestinyProfileResponse { * * COMPONENT TYPE: ItemSockets */ - readonly profilePlugSets: ISingleComponentResponse; + readonly profilePlugSets: SingleComponentResponse; /** * When we have progression information - such as Checklists - that may apply * profile-wide, it will be returned here rather than in the per-character @@ -7021,51 +7361,51 @@ export interface IDestinyProfileResponse { * * COMPONENT TYPE: ProfileProgression */ - readonly profileProgression: ISingleComponentResponse; + readonly profileProgression: SingleComponentResponse; /** COMPONENT TYPE: PresentationNodes */ - readonly profilePresentationNodes: ISingleComponentResponse; + readonly profilePresentationNodes: SingleComponentResponse; /** COMPONENT TYPE: Records */ - readonly profileRecords: ISingleComponentResponse; + readonly profileRecords: SingleComponentResponse; /** COMPONENT TYPE: Collectibles */ - readonly profileCollectibles: ISingleComponentResponse; + readonly profileCollectibles: SingleComponentResponse; /** * Basic information about each character, keyed by the CharacterId. * * COMPONENT TYPE: Characters */ - readonly characters: IDictionaryComponentResponse; + readonly characters: DictionaryComponentResponse; /** * The character-level non-equipped inventory items, keyed by the Character's Id. * * COMPONENT TYPE: CharacterInventories */ - readonly characterInventories: IDictionaryComponentResponse; + readonly characterInventories: DictionaryComponentResponse; /** * Character-level progression data, keyed by the Character's Id. * * COMPONENT TYPE: CharacterProgressions */ - readonly characterProgressions: IDictionaryComponentResponse; + readonly characterProgressions: DictionaryComponentResponse; /** * Character rendering data - a minimal set of info needed to render a character in * 3D - keyed by the Character's Id. * * COMPONENT TYPE: CharacterRenderData */ - readonly characterRenderData: IDictionaryComponentResponse; + readonly characterRenderData: DictionaryComponentResponse; /** * Character activity data - the activities available to this character and its * status, keyed by the Character's Id. * * COMPONENT TYPE: CharacterActivities */ - readonly characterActivities: IDictionaryComponentResponse; + readonly characterActivities: DictionaryComponentResponse; /** * The character's equipped items, keyed by the Character's Id. * * COMPONENT TYPE: CharacterEquipment */ - readonly characterEquipment: IDictionaryComponentResponse; + readonly characterEquipment: DictionaryComponentResponse; /** * Items available from Kiosks that are available to a specific character as * opposed to the account as a whole. It must be combined with data from the @@ -7079,7 +7419,7 @@ export interface IDestinyProfileResponse { * * COMPONENT TYPE: Kiosks */ - readonly characterKiosks: IDictionaryComponentResponse; + readonly characterKiosks: DictionaryComponentResponse; /** * When sockets refer to reusable Plug Sets (see DestinyPlugSetDefinition for more * info), this is the set of plugs and their states, per character, that are @@ -7090,7 +7430,7 @@ export interface IDestinyProfileResponse { * * COMPONENT TYPE: ItemSockets */ - readonly characterPlugSets: IDictionaryComponentResponse; + readonly characterPlugSets: DictionaryComponentResponse; /** * Do you ever get the feeling that a system was designed *too* flexibly? That it * can be used in so many different ways that you end up being unable to provide an @@ -7123,13 +7463,13 @@ export interface IDestinyProfileResponse { * I'm not crying, you're crying Okay we're both crying but it's going to be okay I * promise Actually I shouldn't promise that, I don't know if it's going to be okay */ - readonly characterUninstancedItemComponents: { [key: string]: IDestinyBaseItemComponentSetOfuint32 }; + readonly characterUninstancedItemComponents: { [key: string]: DestinyBaseItemComponentSetOfuint32 }; /** COMPONENT TYPE: PresentationNodes */ - readonly characterPresentationNodes: IDictionaryComponentResponse; + readonly characterPresentationNodes: DictionaryComponentResponse; /** COMPONENT TYPE: Records */ - readonly characterRecords: IDictionaryComponentResponse; + readonly characterRecords: DictionaryComponentResponse; /** COMPONENT TYPE: Collectibles */ - readonly characterCollectibles: IDictionaryComponentResponse; + readonly characterCollectibles: DictionaryComponentResponse; /** * Information about instanced items across all returned characters, keyed by the * item's instance ID. @@ -7137,14 +7477,14 @@ export interface IDestinyProfileResponse { * COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component * types.] */ - readonly itemComponents: IDestinyItemComponentSetOfint64; + readonly itemComponents: DestinyItemComponentSetOfint64; /** * A "lookup" convenience component that can be used to quickly check if the * character has access to items that can be used for purchasing. * * COMPONENT TYPE: CurrencyLookups */ - readonly characterCurrencyLookups: IDictionaryComponentResponse; + readonly characterCurrencyLookups: DictionaryComponentResponse; } /** @@ -7152,9 +7492,9 @@ export interface IDestinyProfileResponse { * purchases that the user has made. In the future, it could be used for providing * refunds/buyback via the API. Wouldn't that be fun? */ -export interface IDestinyVendorReceiptsComponent { +export interface DestinyVendorReceiptsComponent { /** The receipts for refundable purchases made at a vendor. */ - readonly receipts: IDestinyVendorReceipt[]; + readonly receipts: DestinyVendorReceipt[]; } /** @@ -7163,14 +7503,14 @@ export interface IDestinyVendorReceiptsComponent { * of time, but until then can be used to get refunds on items. BNet does not * provide the ability to refund a purchase *yet*, but you know. */ -export interface IDestinyVendorReceipt { +export interface DestinyVendorReceipt { /** * The amount paid for the item, in terms of items that were consumed in the * purchase and their quantity. */ - readonly currencyPaid: IDestinyItemQuantity[]; + readonly currencyPaid: DestinyItemQuantity[]; /** The item that was received, and its quantity. */ - readonly itemReceived: IDestinyItemQuantity; + readonly itemReceived: DestinyItemQuantity; /** The unlock flag used to determine whether you still have the purchased item. */ readonly licenseUnlockHash: number; /** The ID of the character who made the purchase. */ @@ -7188,6 +7528,10 @@ export interface IDestinyVendorReceipt { readonly expiresOn: string; } +/** + * A set of flags for reason(s) why the component populated in the way that it did. + * Inspect the individual flags for the reasons. + */ export const enum ComponentPrivacySetting { None = 0, Public = 1, @@ -7205,12 +7549,12 @@ export const enum ComponentPrivacySetting { * the user's inventory slots, etc. See DestinyInventoryBucketDefinition for more * info. */ -export interface IDestinyInventoryComponent { +export interface DestinyInventoryComponent { /** * The items in this inventory. If you care to bucket them, use the item's * bucketHash property to group them. */ - readonly items: IDestinyItemComponent[]; + readonly items: DestinyItemComponent[]; } /** @@ -7218,12 +7562,12 @@ export interface IDestinyInventoryComponent { * know in any item request or that don't feel worthwhile to put in their own * component. */ -export interface IDestinyItemComponent { +export interface DestinyItemComponent { /** * The identifier for the item's definition, which is where most of the useful * static information for the item can be found. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly itemHash: number; /** @@ -7248,13 +7592,16 @@ export interface IDestinyItemComponent { * The hash identifier for the specific inventory bucket in which the item is * located. * - * Mapped to IDestinyInventoryBucketDefinition in the manifest. + * Mapped to DestinyInventoryBucketDefinition in the manifest. */ readonly bucketHash: number; /** * If there is a known error state that would cause this item to not be * transferable, this Flags enum will indicate all of those error states. Otherwise, * it will be 0 (CanTransfer). + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. */ readonly transferStatus: TransferStatuses; /** If the item can be locked, this will indicate that state. */ @@ -7263,6 +7610,9 @@ export interface IDestinyItemComponent { * A flags enumeration indicating the transient/custom states of the item that * affect how it is rendered: whether it's tracked or locked for example, or * whether it has a masterwork plug inserted. + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. */ readonly state: ItemState; /** @@ -7274,7 +7624,7 @@ export interface IDestinyItemComponent { * socketed items - such as the "Recycle Shader" item - would show whatever their * default icon/style is, and it wouldn't be pretty or look accurate. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly overrideStyleItemHash?: number; /** If the item can expire, this is the date at which it will/did expire. */ @@ -7288,6 +7638,12 @@ export const enum ItemBindStatus { BoundToGuild = 3 } +/** + * Whether you can transfer an item, and why not if you can't. + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum TransferStatuses { /** The item can be transferred. */ CanTransfer = 0, @@ -7305,6 +7661,14 @@ export const enum TransferStatuses { NoRoomInDestination = 4 } +/** + * A flags enumeration/bitmask where each bit represents a different possible state + * that the item can be in that may effect how the item is displayed to the user + * and what actions can be performed against it. + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum ItemState { None = 0, /** @@ -7328,20 +7692,32 @@ export const enum ItemState { * The most essential summary information about a Profile (in Destiny 1, we called * these "Accounts"). */ -export interface IDestinyProfileComponent { +export interface DestinyProfileComponent { /** * If you need to render the Profile (their platform name, icon, etc...) somewhere, * this property contains that information. */ - readonly userInfo: IUserInfoCard; + readonly userInfo: UserInfoCard; /** The last time the user played with any character on this Profile. */ readonly dateLastPlayed: string; - /** If you want to know what expansions they own, this will contain that data. */ + /** + * If you want to know what expansions they own, this will contain that data. + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ readonly versionsOwned: DestinyGameVersions; /** A list of the character IDs, for further querying on your part. */ readonly characterIds: string[]; } +/** + * A flags enumeration/bitmask indicating the versions of the game that a given + * user has purchased. + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum DestinyGameVersions { None = 0, Destiny2 = 1, @@ -7365,19 +7741,19 @@ export const enum DestinyGameVersions { * necessarily content version dependent. Make sure that you have the latest * version of the content manifest databases before using this data. */ -export interface IDestinyKiosksComponent { +export interface DestinyKiosksComponent { /** * A dictionary keyed by the Kiosk Vendor's hash identifier (use it to look up the * DestinyVendorDefinition for the relevant kiosk vendor), and whose value is a * list of all the items that the user can "see" in the Kiosk, and any other * interesting metadata. * - * Mapped to IDestinyVendorDefinition in the manifest. + * Mapped to DestinyVendorDefinition in the manifest. */ - readonly kioskItems: { [key: number]: IDestinyKioskItem[] }; + readonly kioskItems: { [key: number]: DestinyKioskItem[] }; } -export interface IDestinyKioskItem { +export interface DestinyKioskItem { /** * The index of the item in the related DestinyVendorDefintion's itemList property, * representing the sale. @@ -7399,19 +7775,19 @@ export interface IDestinyKioskItem { * flavor" or additional information. For instance, when Emblems track specific * stats, those stats are represented as Objectives on the item. */ - readonly flavorObjective: IDestinyObjectiveProgress; + readonly flavorObjective: DestinyObjectiveProgress; } /** * Returns data about a character's status with a given Objective. Combine with * DestinyObjectiveDefinition static data for display purposes. */ -export interface IDestinyObjectiveProgress { +export interface DestinyObjectiveProgress { /** * The unique identifier of the Objective being referred to. Use to look up the * DestinyObjectiveDefinition in static data. * - * Mapped to IDestinyObjectiveDefinition in the manifest. + * Mapped to DestinyObjectiveDefinition in the manifest. */ readonly objectiveHash: number; /** @@ -7420,7 +7796,7 @@ export interface IDestinyObjectiveProgress { * DestinyDestinationDefinition in static data. This will give localized data about * *where* in the universe the objective should be achieved. * - * Mapped to IDestinyDestinationDefinition in the manifest. + * Mapped to DestinyDestinationDefinition in the manifest. */ readonly destinationHash?: number; /** @@ -7429,7 +7805,7 @@ export interface IDestinyObjectiveProgress { * DestinyActivityDefinition in static data. This will give localized data about * * what* you should be playing for the objective to be achieved. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly activityHash?: number; /** @@ -7474,22 +7850,22 @@ export interface IDestinyObjectiveProgress { * are even more specific will remain on the actual socket component itself, as * they cannot be reused) */ -export interface IDestinyPlugSetsComponent { +export interface DestinyPlugSetsComponent { /** * The shared list of plugs for each relevant PlugSet, keyed by the hash identifier * of the PlugSet (DestinyPlugSetDefinition). * - * Mapped to IDestinyPlugSetDefinition in the manifest. + * Mapped to DestinyPlugSetDefinition in the manifest. */ - readonly plugs: { [key: number]: IDestinyItemPlug[] }; + readonly plugs: { [key: number]: DestinyItemPlug[] }; } -export interface IDestinyItemPlug { +export interface DestinyItemPlug { /** * The hash identifier of the DestinyInventoryItemDefinition that represents this * plug. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly plugItemHash: number; /** @@ -7503,7 +7879,7 @@ export interface IDestinyItemPlug { * progressDescription property. Refer to the plug's itemHash and objective * property for more information if you would like to display even more data. */ - readonly plugObjectives: IDestinyObjectiveProgress[]; + readonly plugObjectives: DestinyObjectiveProgress[]; /** If true, this plug has met all of its insertion requirements. Big if true. */ readonly canInsert: boolean; /** If true, this plug will provide its benefits while inserted. */ @@ -7536,12 +7912,12 @@ export interface IDestinyItemPlug { * relationship between these reusable plug sets and the sockets that leverage them * (for starters, Emotes). */ -export interface IDestinyPlugSetDefinition { +export interface DestinyPlugSetDefinition { /** * If you want to show these plugs in isolation, these are the display properties * for them. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * This is a list of pre-determined plugs that can be plugged into this socket, * without the character having the plug in their inventory. @@ -7549,7 +7925,7 @@ export interface IDestinyPlugSetDefinition { * If this list is populated, you will not be allowed to plug an arbitrary item in * the socket: you will only be able to choose from one of these reusable plugs. */ - readonly reusablePlugItems: IDestinyItemSocketEntryPlugItemDefinition[]; + readonly reusablePlugItems: DestinyItemSocketEntryPlugItemDefinition[]; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -7574,7 +7950,7 @@ export interface IDestinyPlugSetDefinition { * * This will include information such as Checklist info. */ -export interface IDestinyProfileProgressionComponent { +export interface DestinyProfileProgressionComponent { /** * The set of checklists that can be examined on a profile-wide basis, keyed by the * hash identifier of the Checklist (DestinyChecklistDefinition) @@ -7583,7 +7959,7 @@ export interface IDestinyProfileProgressionComponent { * checklist's hash identifier with the value being a boolean indicating if it's * been discovered yet. * - * Mapped to IDestinyChecklistDefinition in the manifest. + * Mapped to DestinyChecklistDefinition in the manifest. */ readonly checklists: { [key: number]: { [key: number]: boolean } }; } @@ -7609,8 +7985,8 @@ export interface IDestinyProfileProgressionComponent { * be the case, so for now assume that the Checklists will still exist even after * the release of D2: Forsaken. */ -export interface IDestinyChecklistDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyChecklistDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** A localized string prompting you to view the checklist. */ readonly viewActionString: string; /** @@ -7619,7 +7995,7 @@ export interface IDestinyChecklistDefinition { */ readonly scope: DestinyScope; /** The individual checklist items. Gotta catch 'em all. */ - readonly entries: IDestinyChecklistEntryDefinition[]; + readonly entries: DestinyChecklistEntryDefinition[]; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -7645,7 +8021,7 @@ export interface IDestinyChecklistDefinition { * Whatever UI you build, do it with the knowledge that any given entry might not * actually be able to be associated with some other Destiny entity. */ -export interface IDestinyChecklistEntryDefinition { +export interface DestinyChecklistEntryDefinition { /** * The identifier for this Checklist entry. Guaranteed unique only within this * Checklist Definition, and not globally/for all checklists. @@ -7656,10 +8032,10 @@ export interface IDestinyChecklistEntryDefinition { * properties. In cases where we have no associated entities, it may be as simple * as a numerical identifier. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; - /** Mapped to IDestinyDestinationDefinition in the manifest. */ + readonly displayProperties: DestinyDisplayPropertiesDefinition; + /** Mapped to DestinyDestinationDefinition in the manifest. */ readonly destinationHash?: number; - /** Mapped to IDestinyLocationDefinition in the manifest. */ + /** Mapped to DestinyLocationDefinition in the manifest. */ readonly locationHash?: number; /** * Note that a Bubble's hash doesn't uniquely identify a "top level" entity in @@ -7672,9 +8048,9 @@ export interface IDestinyChecklistEntryDefinition { * property. */ readonly bubbleHash?: number; - /** Mapped to IDestinyActivityDefinition in the manifest. */ + /** Mapped to DestinyActivityDefinition in the manifest. */ readonly activityHash?: number; - /** Mapped to IDestinyInventoryItemDefinition in the manifest. */ + /** Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly itemHash?: number; readonly vendorHash?: number; readonly vendorInteractionIndex?: number; @@ -7682,11 +8058,15 @@ export interface IDestinyChecklistEntryDefinition { readonly scope: DestinyScope; } -export interface IDestinyPresentationNodesComponent { - readonly nodes: { [key: number]: IDestinyPresentationNodeComponent }; +export interface DestinyPresentationNodesComponent { + readonly nodes: { [key: number]: DestinyPresentationNodeComponent }; } -export interface IDestinyPresentationNodeComponent { +export interface DestinyPresentationNodeComponent { + /** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ readonly state: DestinyPresentationNodeState; /** * An optional property: presentation nodes MAY have objectives, which can be used @@ -7694,7 +8074,7 @@ export interface IDestinyPresentationNodeComponent { * completionValue ought to be considered the canonical values for progress on * Progression Nodes. */ - readonly objective: IDestinyObjectiveProgress; + readonly objective: DestinyObjectiveProgress; /** * How much of the presentation node is considered to be completed so far by the * given character/profile. @@ -7704,6 +8084,15 @@ export interface IDestinyPresentationNodeComponent { readonly completionValue: number; } +/** + * I know this doesn't look like a Flags Enumeration/bitmask right now, but I + * assure you it is. This is the possible states that a Presentation Node can be in, + * and it is almost certain that its potential states will increase in the future. + * So don't treat it like a straight up enumeration. + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum DestinyPresentationNodeState { None = 0, /** @@ -7715,24 +8104,35 @@ export const enum DestinyPresentationNodeState { Obscured = 2 } -export interface IDestinyProfileRecordsComponent { +export interface DestinyProfileRecordsComponent { /** Your "Triumphs" score. */ readonly score: number; /** * If this profile is tracking a record, this is the hash identifier of the record * it is tracking. * - * Mapped to IDestinyRecordDefinition in the manifest. + * Mapped to DestinyRecordDefinition in the manifest. */ readonly trackedRecordHash?: number; - readonly records: { [key: number]: IDestinyRecordComponent }; + readonly records: { [key: number]: DestinyRecordComponent }; } -export interface IDestinyRecordComponent { +export interface DestinyRecordComponent { + /** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ readonly state: DestinyRecordState; - readonly objectives: IDestinyObjectiveProgress[]; + readonly objectives: DestinyObjectiveProgress[]; } +/** + * A Flags enumeration/bitmask where each bit represents a possible state that a + * Record/Triumph can be in. + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum DestinyRecordState { /** * If there are no flags set, the record is in a state where it *could* be redeemed, @@ -7770,12 +8170,12 @@ export const enum DestinyRecordState { CanEquipTitle = 64 } -export interface IDestinyProfileCollectiblesComponent { +export interface DestinyProfileCollectiblesComponent { /** * The list of collectibles determined by the game as having been "recently" * acquired. * - * Mapped to IDestinyCollectibleDefinition in the manifest. + * Mapped to DestinyCollectibleDefinition in the manifest. */ readonly recentCollectibleHashes: number[]; /** @@ -7786,16 +8186,38 @@ export interface IDestinyProfileCollectiblesComponent { * whether anyone will get much use out of this: because we can't edit this value * through the API. But in case anyone finds it useful, here it is. * - * Mapped to IDestinyCollectibleDefinition in the manifest. + * Mapped to DestinyCollectibleDefinition in the manifest. */ readonly newnessFlaggedCollectibleHashes: number[]; - readonly collectibles: { [key: number]: IDestinyCollectibleComponent }; + readonly collectibles: { [key: number]: DestinyCollectibleComponent }; } -export interface IDestinyCollectibleComponent { +export interface DestinyCollectibleComponent { + /** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ readonly state: DestinyCollectibleState; } +/** + * A Flags Enumeration/bitmask where each bit represents a different state that the + * Collectible can be in. A collectible can be in any number of these states, and + * you can choose to use or ignore any or all of them when making your own UI that + * shows Collectible info. Our displays are going to honor them, but we're also the + * kind of people who only pretend to inhale before quickly passing it to the left. + * So, you know, do what you got to do. + * + * (All joking aside, please note the caveat I mention around the Invisible flag: + * there are cases where it is in the best interest of your users to honor these + * flags even if you're a "show all the data" person. Collector-oriented compulsion + * is a very unfortunate and real thing, and I would hate to instill that + * compulsion in others through showing them items that they cannot earn. Please + * consider this when you are making your own apps/sites.) + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum DestinyCollectibleState { None = 0, /** If this flag is set, you have not yet obtained this collectible. */ @@ -7847,7 +8269,7 @@ export const enum DestinyCollectibleState { * This component contains base properties of the character. You'll probably want * to always request this component, but hey you do you. */ -export interface IDestinyCharacterComponent { +export interface DestinyCharacterComponent { /** * Every Destiny Profile has a membershipId. This is provided on the character as * well for convenience. @@ -7887,19 +8309,19 @@ export interface IDestinyCharacterComponent { /** * Use this hash to look up the character's DestinyRaceDefinition. * - * Mapped to IDestinyRaceDefinition in the manifest. + * Mapped to DestinyRaceDefinition in the manifest. */ readonly raceHash: number; /** * Use this hash to look up the character's DestinyGenderDefinition. * - * Mapped to IDestinyGenderDefinition in the manifest. + * Mapped to DestinyGenderDefinition in the manifest. */ readonly genderHash: number; /** * Use this hash to look up the character's DestinyClassDefinition. * - * Mapped to IDestinyClassDefinition in the manifest. + * Mapped to DestinyClassDefinition in the manifest. */ readonly classHash: number; /** @@ -7943,20 +8365,20 @@ export interface IDestinyCharacterComponent { * The hash of the currently equipped emblem for the user. Can be used to look up * the DestinyInventoryItemDefinition. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly emblemHash: number; /** * A shortcut for getting the background color of the user's currently equipped * emblem without having to do a DestinyInventoryItemDefinition lookup. */ - readonly emblemColor: IDestinyColor; + readonly emblemColor: DestinyColor; /** * The progression that indicates your character's level. Not their light level, * but their character level: you know, the thing you max out a couple hours in and * then ignore for the sake of light level. */ - readonly levelProgression: IDestinyProgression; + readonly levelProgression: DestinyProgression; /** The "base" level of your character, not accounting for any light level. */ readonly baseCharacterLevel: number; /** @@ -7968,7 +8390,7 @@ export interface IDestinyCharacterComponent { * If this Character has a title assigned to it, this is the identifier of the * DestinyRecordDefinition that has that title information. * - * Mapped to IDestinyRecordDefinition in the manifest. + * Mapped to DestinyRecordDefinition in the manifest. */ readonly titleRecordHash?: number; } @@ -7979,8 +8401,8 @@ export interface IDestinyCharacterComponent { * defined here. You'll see Exo, Awoken, and Human as examples of these Species. * Players will choose one for their character. */ -export interface IDestinyRaceDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyRaceDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * An enumeration defining the existing, known Races/Species for player characters. * This value will be the enum value matching this definition. @@ -7990,8 +8412,8 @@ export interface IDestinyRaceDefinition { * A localized string referring to the singular form of the Race's name when * referred to in gendered form. Keyed by the DestinyGender. */ - readonly genderedRaceNames: { [key: number]: string }; - /** Mapped to IDestinyGenderDefinition in the manifest. */ + readonly genderedRaceNames: { [key in DestinyGender]: string }; + /** Mapped to DestinyGenderDefinition in the manifest. */ readonly genderedRaceNamesByGenderHash: { [key: number]: string }; /** * The unique identifier for this entity. Guaranteed to be unique for the type of @@ -8021,25 +8443,25 @@ export const enum DestinyRace { * Defines a Character Class in Destiny 2. These are types of characters you can * play, like Titan, Warlock, and Hunter. */ -export interface IDestinyClassDefinition { +export interface DestinyClassDefinition { /** * In Destiny 1, we added a convenience Enumeration for referring to classes. We've * kept it, though mostly for posterity. This is the enum value for this definition' * s class. */ readonly classType: DestinyClass; - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * A localized string referring to the singular form of the Class's name when * referred to in gendered form. Keyed by the DestinyGender. */ - readonly genderedClassNames: { [key: number]: string }; - /** Mapped to IDestinyGenderDefinition in the manifest. */ + readonly genderedClassNames: { [key in DestinyGender]: string }; + /** Mapped to DestinyGenderDefinition in the manifest. */ readonly genderedClassNamesByGenderHash: { [key: number]: string }; /** * Mentors don't really mean anything anymore. Don't expect this to be populated. * - * Mapped to IDestinyVendorDefinition in the manifest. + * Mapped to DestinyVendorDefinition in the manifest. */ readonly mentorVendorHash?: number; /** @@ -8063,7 +8485,7 @@ export interface IDestinyClassDefinition { * This component returns anything that could be considered "Progression" on a user: * data where the user is gaining levels, reputation, completions, rewards, etc... */ -export interface IDestinyCharacterProgressionComponent { +export interface DestinyCharacterProgressionComponent { /** * A Dictionary of all known progressions for the Character, keyed by the * Progression's hash. @@ -8071,31 +8493,31 @@ export interface IDestinyCharacterProgressionComponent { * Not all progressions have user-facing data, but those who do will have that data * contained in the DestinyProgressionDefinition. * - * Mapped to IDestinyProgressionDefinition in the manifest. + * Mapped to DestinyProgressionDefinition in the manifest. */ - readonly progressions: { [key: number]: IDestinyProgression }; + readonly progressions: { [key: number]: DestinyProgression }; /** * A dictionary of all known Factions, keyed by the Faction's hash. It contains * data about this character's status with the faction. * - * Mapped to IDestinyFactionDefinition in the manifest. + * Mapped to DestinyFactionDefinition in the manifest. */ - readonly factions: { [key: number]: IDestinyFactionProgression }; + readonly factions: { [key: number]: DestinyFactionProgression }; /** * Milestones are related to the simple progressions shown in the game, but return * additional and hopefully helpful information for users about the specifics of * the Milestone's status. * - * Mapped to IDestinyMilestoneDefinition in the manifest. + * Mapped to DestinyMilestoneDefinition in the manifest. */ - readonly milestones: { [key: number]: IDestinyMilestone }; + readonly milestones: { [key: number]: DestinyMilestone }; /** * If the user has any active quests, the quests' statuses will be returned here. * * Note that quests have been largely supplanted by Milestones, but that doesn't * mean that they won't make a comeback independent of milestones at some point. */ - readonly quests: IDestinyQuestStatus[]; + readonly quests: DestinyQuestStatus[]; /** * Sometimes, you have items in your inventory that don't have instances, but still * have Objective information. This provides you that objective information for @@ -8105,9 +8527,9 @@ export interface IDestinyCharacterProgressionComponent { * name and description for the overall task(s) implied by the objective. The value * is the list of objectives for this item, and their statuses. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ - readonly uninstancedItemObjectives: { [key: number]: IDestinyObjectiveProgress[] }; + readonly uninstancedItemObjectives: { [key: number]: DestinyObjectiveProgress[] }; /** * The set of checklists that can be examined for this specific character, keyed by * the hash identifier of the Checklist (DestinyChecklistDefinition) @@ -8116,7 +8538,7 @@ export interface IDestinyCharacterProgressionComponent { * checklist's hash identifier with the value being a boolean indicating if it's * been discovered yet. * - * Mapped to IDestinyChecklistDefinition in the manifest. + * Mapped to DestinyChecklistDefinition in the manifest. */ readonly checklists: { [key: number]: { [key: number]: boolean } }; } @@ -8126,12 +8548,12 @@ export interface IDestinyCharacterProgressionComponent { * progressions. This is just a DestinyProgression with a shortcut for finding the * DestinyFactionDefinition of the faction related to the progression. */ -export interface IDestinyFactionProgression { +export interface DestinyFactionProgression { /** * The hash identifier of the Faction related to this progression. Use it to look * up the DestinyFactionDefinition for more rendering info. * - * Mapped to IDestinyFactionDefinition in the manifest. + * Mapped to DestinyFactionDefinition in the manifest. */ readonly factionHash: number; /** @@ -8143,7 +8565,7 @@ export interface IDestinyFactionProgression { * The hash identifier of the Progression in question. Use it to look up the * DestinyProgressionDefinition in static data. * - * Mapped to IDestinyProgressionDefinition in the manifest. + * Mapped to DestinyProgressionDefinition in the manifest. */ readonly progressionHash: number; /** The amount of progress earned today for this progression. */ @@ -8194,13 +8616,13 @@ export interface IDestinyFactionProgression { * regards to said "things to do." Consider it a big, wonky to-do list, or Advisors * 3.0 for those who remember the Destiny 1 API. */ -export interface IDestinyMilestone { +export interface DestinyMilestone { /** * The unique identifier for the Milestone. Use it to look up the * DestinyMilestoneDefinition, so you can combine the other data in this contract * with static definition data. * - * Mapped to IDestinyMilestoneDefinition in the manifest. + * Mapped to DestinyMilestoneDefinition in the manifest. */ readonly milestoneHash: number; /** @@ -8211,7 +8633,7 @@ export interface IDestinyMilestone { * determine which one(s) are actually active right now. It is possible for * Milestones to not have any quests. */ - readonly availableQuests: IDestinyMilestoneQuest[]; + readonly availableQuests: DestinyMilestoneQuest[]; /** * The currently active Activities in this milestone, when the Milestone is driven * by Challenges. @@ -8219,7 +8641,7 @@ export interface IDestinyMilestone { * Not all Milestones have Challenges, but when they do this will indicate the * Activities and Challenges under those Activities related to this Milestone. */ - readonly activities: IDestinyMilestoneChallengeActivity[]; + readonly activities: DestinyMilestoneChallengeActivity[]; /** * Milestones may have arbitrary key/value pairs associated with them, for data * that users will want to know about but that doesn't fit neatly into any of the @@ -8245,7 +8667,7 @@ export interface IDestinyMilestone { * Before we even use it, it's already deprecated! How much of a bummer is that? We * need more data. * - * Mapped to IDestinyVendorDefinition in the manifest. + * Mapped to DestinyVendorDefinition in the manifest. */ readonly vendorHashes: number[]; /** @@ -8255,7 +8677,7 @@ export interface IDestinyMilestone { * data - for example, if the Vendor is featuring a specific item relevant to this * event that you should show with them. */ - readonly vendors: IDestinyMilestoneVendor[]; + readonly vendors: DestinyMilestoneVendor[]; /** * If the entity to which this component is attached has known active Rewards for * the player, this will detail information about those rewards, keyed by the @@ -8265,7 +8687,7 @@ export interface IDestinyMilestone { * for Milestones that may provide rewards for performing a variety of tasks that * aren't under a specific Quest. */ - readonly rewards: IDestinyMilestoneRewardCategory[]; + readonly rewards: DestinyMilestoneRewardCategory[]; /** * If known, this is the date when the event last began or refreshed. It will only * be populated for events with fixed and repeating start and end dates. @@ -8329,8 +8751,8 @@ export interface IDestinyMilestone { * This approach will let you avoid, whenever possible, the even less useful (and * sometimes nonexistant) milestone-level names and descriptions. */ -export interface IDestinyMilestoneDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyMilestoneDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** A custom image someone made just for the milestone. Isn't that special? */ readonly image: string; /** @@ -8385,7 +8807,7 @@ export interface IDestinyMilestoneDefinition { * many types of activities. There will likely be further revisions to the * Milestone concept in the future. */ - readonly quests: { [key: number]: IDestinyMilestoneQuestDefinition }; + readonly quests: { [key: number]: DestinyMilestoneQuestDefinition }; /** * If this milestone can provide rewards, this will define the categories into * which the individual reward entries are placed. @@ -8393,7 +8815,7 @@ export interface IDestinyMilestoneDefinition { * This is keyed by the Category's hash, which is only guaranteed to be unique * within a given Milestone. */ - readonly rewards: { [key: number]: IDestinyMilestoneRewardCategoryDefinition }; + readonly rewards: { [key: number]: DestinyMilestoneRewardCategoryDefinition }; /** * If you're going to show Vendors for the Milestone, you can use this as a * localized "header" for the section where you show that vendor data. It'll @@ -8407,14 +8829,14 @@ export interface IDestinyMilestoneDefinition { * in which they should be returned if order matters, and the conditions under * which the Vendor is relevant to the user. */ - readonly vendors: IDestinyMilestoneVendorDefinition[]; + readonly vendors: DestinyMilestoneVendorDefinition[]; /** * Sometimes, milestones will have arbitrary values associated with them that are * of interest to us or to third party developers. This is the collection of those * values' definitions, keyed by the identifier of the value and providing useful * definition information such as localizable names and descriptions for the value. */ - readonly values: { [key: string]: IDestinyMilestoneValueDefinition }; + readonly values: { [key: string]: DestinyMilestoneValueDefinition }; /** * Some milestones are explicit objectives that you can see and interact with in * the game. Some milestones are more conceptual, built by BNet to help advise you @@ -8429,7 +8851,7 @@ export interface IDestinyMilestoneDefinition { * backing Quest), and that activity can have many challenges, modifiers, and * related to it. */ - readonly activities: IDestinyMilestoneChallengeActivityDefinition[]; + readonly activities: DestinyMilestoneChallengeActivityDefinition[]; readonly defaultOrder: number; /** * The unique identifier for this entity. Guaranteed to be unique for the type of @@ -8448,6 +8870,10 @@ export interface IDestinyMilestoneDefinition { readonly redacted: boolean; } +/** + * The type of milestone. Milestones can be Tutorials, one-time/triggered/non- + * repeating but not necessarily tutorials, or Repeating Milestones. + */ export const enum DestinyMilestoneType { Unknown = 0, /** @@ -8477,13 +8903,13 @@ export const enum DestinyMilestoneType { * one for the conceptual Milestone. Even just typing this description, I already * regret it. */ -export interface IDestinyMilestoneQuestDefinition { +export interface DestinyMilestoneQuestDefinition { /** * The item representing this Milestone quest. Use this hash to look up the * DestinyInventoryItemDefinition for the quest to find its steps and human * readable data. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly questItemHash: number; /** @@ -8491,7 +8917,7 @@ export interface IDestinyMilestoneQuestDefinition { * if there's a specific active quest, use these displayProperties instead of that * of the overall DestinyMilestoneDefinition. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * If populated, this image can be shown instead of the generic milestone's image * when this quest is live, or it can be used to show a background image for the @@ -8503,23 +8929,23 @@ export interface IDestinyMilestoneQuestDefinition { * them from our data. Sometimes, it'll be a decent amount of data. Sometimes, it's * going to be sucky. Sorry. */ - readonly questRewards: IDestinyMilestoneQuestRewardsDefinition; + readonly questRewards: DestinyMilestoneQuestRewardsDefinition; /** * The full set of all possible "conceptual activities" that are related to this * Milestone. Tiers or alternative modes of play within these conceptual activities * will be defined as sub-entities. Keyed by the Conceptual Activity Hash. Use the * key to look up DestinyActivityDefinition. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ - readonly activities: { [key: number]: IDestinyMilestoneActivityDefinition }; + readonly activities: { [key: number]: DestinyMilestoneActivityDefinition }; /** * Sometimes, a Milestone's quest is related to an entire Destination rather than a * specific activity. In that situation, this will be the hash of that Destination. * Hotspots are currently the only Milestones that expose this data, but that does * not preclude this data from being returned for other Milestones in the future. * - * Mapped to IDestinyDestinationDefinition in the manifest. + * Mapped to DestinyDestinationDefinition in the manifest. */ readonly destinationHash?: number; } @@ -8532,7 +8958,7 @@ export interface IDestinyMilestoneQuestDefinition { * Remember this if you come back and ask "why are quest reward items nested * inside of their own class?" */ -export interface IDestinyMilestoneQuestRewardsDefinition { +export interface DestinyMilestoneQuestRewardsDefinition { /** * The items that represent your reward for completing the quest. * @@ -8544,7 +8970,7 @@ export interface IDestinyMilestoneQuestRewardsDefinition { * a programmatic association between those and whatever Progression is actually * getting that experience... yet. */ - readonly items: IDestinyMilestoneQuestRewardItem[]; + readonly items: DestinyMilestoneQuestRewardItem[]; } /** @@ -8555,12 +8981,12 @@ export interface IDestinyMilestoneQuestRewardsDefinition { * If you want it, please ask! We're just out of time to wire it up right now. Or a * clever person just may do it with our existing endpoints. */ -export interface IDestinyMilestoneQuestRewardItem { +export interface DestinyMilestoneQuestRewardItem { /** * The quest reward item *may* be associated with a vendor. If so, this is that * vendor. Use this hash to look up the DestinyVendorDefinition. * - * Mapped to IDestinyVendorDefinition in the manifest. + * Mapped to DestinyVendorDefinition in the manifest. */ readonly vendorHash?: number; /** @@ -8573,7 +8999,7 @@ export interface IDestinyMilestoneQuestRewardItem { * The hash identifier for the item in question. Use it to look up the item's * DestinyInventoryItemDefinition. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly itemHash: number; /** @@ -8597,7 +9023,7 @@ export interface IDestinyMilestoneQuestRewardItem { * Tier data to establish a relationship between a conceptual Activity and its * difficulty levels and variants. */ -export interface IDestinyMilestoneActivityDefinition { +export interface DestinyMilestoneActivityDefinition { /** * The "Conceptual" activity hash. Basically, we picked the lowest level activity * and are treating it as the canonical definition of the activity for rendering @@ -8606,7 +9032,7 @@ export interface IDestinyMilestoneActivityDefinition { * If you care about the specific difficulty modes and variations, use the * activities under "Variants". * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly conceptualActivityHash: number; /** @@ -8623,9 +9049,9 @@ export interface IDestinyMilestoneActivityDefinition { * should all have their own DestinyMilestoneActivityDefinition instead! The * potential duplication will be worth it for the obviousness of processing and use. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ - readonly variants: { [key: number]: IDestinyMilestoneActivityVariantDefinition }; + readonly variants: { [key: number]: DestinyMilestoneActivityVariantDefinition }; } /** @@ -8635,7 +9061,7 @@ export interface IDestinyMilestoneActivityDefinition { * These will often have more specific details, such as an associated Guided Game, * progression steps, tier-specific rewards, and custom values. */ -export interface IDestinyMilestoneActivityVariantDefinition { +export interface DestinyMilestoneActivityVariantDefinition { /** * The hash to use for looking up the variant Activity's definition ( * DestinyActivityDefinition), where you can find its distinguishing @@ -8644,7 +9070,7 @@ export interface IDestinyMilestoneActivityVariantDefinition { * Frequently, that will be the only distinguishing characteristics in practice, * which is somewhat of a bummer. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly activityHash: number; /** @@ -8657,7 +9083,7 @@ export interface IDestinyMilestoneActivityVariantDefinition { } /** The definition of a category of rewards, that contains many individual rewards. */ -export interface IDestinyMilestoneRewardCategoryDefinition { +export interface DestinyMilestoneRewardCategoryDefinition { /** * Identifies the reward category. Only guaranteed unique within this specific * component! @@ -8669,14 +9095,14 @@ export interface IDestinyMilestoneRewardCategoryDefinition { */ readonly categoryIdentifier: string; /** Hopefully this is obvious by now. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * If this milestone can provide rewards, this will define the sets of rewards that * can be earned, the conditions under which they can be acquired, internal data * that we'll use at runtime to determine whether you've already earned or redeemed * this set of rewards, and the category that this reward should be placed under. */ - readonly rewardEntries: { [key: number]: IDestinyMilestoneRewardEntryDefinition }; + readonly rewardEntries: { [key: number]: DestinyMilestoneRewardEntryDefinition }; /** * If you want to use BNet's recommended order for rendering categories * programmatically, use this value and compare it to other categories to determine @@ -8690,7 +9116,7 @@ export interface IDestinyMilestoneRewardCategoryDefinition { * The definition of a specific reward, which may be contained in a category of * rewards and that has optional information about how it is obtained. */ -export interface IDestinyMilestoneRewardEntryDefinition { +export interface DestinyMilestoneRewardEntryDefinition { /** * The identifier for this reward entry. Runtime data will refer to reward entries * by this hash. Only guaranteed unique within the specific Milestone. @@ -8702,13 +9128,13 @@ export interface IDestinyMilestoneRewardEntryDefinition { */ readonly rewardEntryIdentifier: string; /** The items you will get as rewards, and how much of it you'll get. */ - readonly items: IDestinyItemQuantity[]; + readonly items: DestinyItemQuantity[]; /** * If this reward is redeemed at a Vendor, this is the hash of the Vendor to go to * in order to redeem the reward. Use this hash to look up the * DestinyVendorDefinition. * - * Mapped to IDestinyVendorDefinition in the manifest. + * Mapped to DestinyVendorDefinition in the manifest. */ readonly vendorHash?: number; /** @@ -8716,7 +9142,7 @@ export interface IDestinyMilestoneRewardEntryDefinition { * information about why these rewards are grouped together. This is ideally that * information. Look at how confident I am that this will always remain true. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * If you want to follow BNet's ordering of these rewards, use this number within a * given category to order the rewards. Yeah, I know. I feel dirty too. @@ -8731,12 +9157,12 @@ export interface IDestinyMilestoneRewardEntryDefinition { * It also contains information we need to determine whether that vendor is * actually relevant at the moment, given the user's current state. */ -export interface IDestinyMilestoneVendorDefinition { +export interface DestinyMilestoneVendorDefinition { /** * The hash of the vendor whose wares should be shown as associated with the * Milestone. * - * Mapped to IDestinyVendorDefinition in the manifest. + * Mapped to DestinyVendorDefinition in the manifest. */ readonly vendorHash: number; } @@ -8748,40 +9174,40 @@ export interface IDestinyMilestoneVendorDefinition { * This lets us more flexibly pass up information that's useful to someone, even if * it's not necessarily us. */ -export interface IDestinyMilestoneValueDefinition { +export interface DestinyMilestoneValueDefinition { readonly key: string; - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; } -export interface IDestinyMilestoneChallengeActivityDefinition { +export interface DestinyMilestoneChallengeActivityDefinition { /** The activity for which this challenge is active. */ readonly activityHash: number; - readonly challenges: IDestinyMilestoneChallengeDefinition[]; + readonly challenges: DestinyMilestoneChallengeDefinition[]; /** * If the activity and its challenge is visible on any of these nodes, it will be * returned. */ - readonly activityGraphNodes: IDestinyMilestoneChallengeActivityGraphNodeEntry[]; + readonly activityGraphNodes: DestinyMilestoneChallengeActivityGraphNodeEntry[]; /** * Phases related to this activity, if there are any. * * These will be listed in the order in which they will appear in the actual * activity. */ - readonly phases: IDestinyMilestoneChallengeActivityPhase[]; + readonly phases: DestinyMilestoneChallengeActivityPhase[]; } -export interface IDestinyMilestoneChallengeDefinition { +export interface DestinyMilestoneChallengeDefinition { /** The challenge related to this milestone. */ readonly challengeObjectiveHash: number; } -export interface IDestinyMilestoneChallengeActivityGraphNodeEntry { +export interface DestinyMilestoneChallengeActivityGraphNodeEntry { readonly activityGraphHash: number; readonly activityGraphNodeHash: number; } -export interface IDestinyMilestoneChallengeActivityPhase { +export interface DestinyMilestoneChallengeActivityPhase { /** The hash identifier of the activity's phase. */ readonly phaseHash: number; } @@ -8790,7 +9216,7 @@ export interface IDestinyMilestoneChallengeActivityPhase { * If a Milestone has one or more Quests, this will contain the live information * for the character's status with one of those quests. */ -export interface IDestinyMilestoneQuest { +export interface DestinyMilestoneQuest { /** * Quests are defined as Items in content. As such, this is the hash identifier of * the DestinyInventoryItemDefinition that represents this quest. It will have @@ -8799,11 +9225,11 @@ export interface IDestinyMilestoneQuest { * item's DestinyInventoryItemDefinition.setData property, and themselves are Items * with their own renderable data. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly questItemHash: number; /** The current status of the quest for the character making the request. */ - readonly status: IDestinyQuestStatus; + readonly status: DestinyQuestStatus; /** * *IF* the Milestone has an active Activity that can give you greater details * about what you need to do, it will be returned here. Remember to associate this @@ -8811,7 +9237,7 @@ export interface IDestinyMilestoneQuest { * activity, including what specific quest it is related to if you have multiple * quests to choose from. */ - readonly activity: IDestinyMilestoneActivity; + readonly activity: DestinyMilestoneActivity; /** * The activities referred to by this quest can have many associated challenges. * They are all contained here, with activityHashes so that you can associate them @@ -8822,7 +9248,7 @@ export interface IDestinyMilestoneQuest { * but it probably should have been in both places. That may come as a later * revision. */ - readonly challenges: IDestinyChallengeStatus[]; + readonly challenges: DestinyChallengeStatus[]; } /** @@ -8831,7 +9257,7 @@ export interface IDestinyMilestoneQuest { * QuestStatus will return Objective data for the *currently active* step in this * quest. */ -export interface IDestinyQuestStatus { +export interface DestinyQuestStatus { /** * The hash identifier for the Quest Item. (Note: Quests are defined as Items, and * thus you would use this to look up the quest's DestinyInventoryItemDefinition). @@ -8840,7 +9266,7 @@ export interface IDestinyQuestStatus { * items). You can use the Item Definition to display human readable data about * the overall quest. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly questHash: number; /** @@ -8848,14 +9274,14 @@ export interface IDestinyQuestStatus { * DestinyInventoryItemDefinition. You can use this to get human readable data * about the current step and what to do in that step. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly stepHash: number; /** * A step can have multiple objectives. This will give you the progress for each * objective in the current step, in the order in which they are rendered in-game. */ - readonly stepObjectives: IDestinyObjectiveProgress[]; + readonly stepObjectives: DestinyObjectiveProgress[]; /** Whether or not the quest is tracked */ readonly tracked: boolean; /** @@ -8885,7 +9311,7 @@ export interface IDestinyQuestStatus { * This entity provides additional information about that Activity and all of its * variants. (sometimes there's only one variant, but I think you get the point) */ -export interface IDestinyMilestoneActivity { +export interface DestinyMilestoneActivity { /** * The hash of an arbitrarily chosen variant of this activity. We'll go ahead and * call that the "canonical" activity, because if you're using this value you @@ -8893,7 +9319,7 @@ export interface IDestinyMilestoneActivity { * like the name of the activity, it's location, etc... Use this hash to look up * the DestinyActivityDefinition of this activity for rendering data. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly activityHash: number; /** @@ -8903,7 +9329,7 @@ export interface IDestinyMilestoneActivity { * under. If it's a playlist, this will be less specific: but hopefully useful in * some way. * - * Mapped to IDestinyActivityModeDefinition in the manifest. + * Mapped to DestinyActivityModeDefinition in the manifest. */ readonly activityModeHash?: number; /** @@ -8920,7 +9346,7 @@ export interface IDestinyMilestoneActivity { * modifiers for the activity, not the active ones. Use only the active ones to * match what's really live. * - * Mapped to IDestinyActivityModifierDefinition in the manifest. + * Mapped to DestinyActivityModifierDefinition in the manifest. */ readonly modifierHashes: number[]; /** @@ -8929,17 +9355,17 @@ export interface IDestinyMilestoneActivity { * arbitrary ways, like difficulty level and modifiers applied. Show it in whatever * way tickles your fancy. */ - readonly variants: IDestinyMilestoneActivityVariant[]; + readonly variants: DestinyMilestoneActivityVariant[]; } /** Represents custom data that we know about an individual variant of an activity. */ -export interface IDestinyMilestoneActivityVariant { +export interface DestinyMilestoneActivityVariant { /** * The hash for the specific variant of the activity related to this milestone. You * can pull more detailed static info from the DestinyActivityDefinition, such as * difficulty level. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly activityHash: number; /** @@ -8947,7 +9373,7 @@ export interface IDestinyMilestoneActivityVariant { * terms of whether or not it has been completed or what progress you have made in * it, this will be returned. Otherwise, this will be NULL. */ - readonly completionStatus: IDestinyMilestoneActivityCompletionStatus; + readonly completionStatus: DestinyMilestoneActivityCompletionStatus; /** * The hash identifier of the most specific Activity Mode under which this activity * is played. This is useful for situations where the activity in question is - for @@ -8955,7 +9381,7 @@ export interface IDestinyMilestoneActivityVariant { * under. If it's a playlist, this will be less specific: but hopefully useful in * some way. * - * Mapped to IDestinyActivityModeDefinition in the manifest. + * Mapped to DestinyActivityModeDefinition in the manifest. */ readonly activityModeHash?: number; /** @@ -8972,7 +9398,7 @@ export interface IDestinyMilestoneActivityVariant { * to talk about a tier of a raid as being Completed or having progress, but it * doesn't make sense to talk about a Crucible Playlist in those terms. */ -export interface IDestinyMilestoneActivityCompletionStatus { +export interface DestinyMilestoneActivityCompletionStatus { /** If the activity has been "completed", that information will be returned here. */ readonly completed: boolean; /** @@ -8981,7 +9407,7 @@ export interface IDestinyMilestoneActivityCompletionStatus { * dictionary: the order implies the ascending order of phases or progression in * this activity. */ - readonly phases: IDestinyMilestoneActivityPhase[]; + readonly phases: DestinyMilestoneActivityPhase[]; } /** @@ -8990,7 +9416,7 @@ export interface IDestinyMilestoneActivityCompletionStatus { * and did something," but for the forseeable future that's all we've got. I'm * making it more than just a list of booleans out of that overly-optimistic hope. */ -export interface IDestinyMilestoneActivityPhase { +export interface DestinyMilestoneActivityPhase { /** Indicates if the phase has been completed. */ readonly complete: boolean; /** @@ -9008,15 +9434,15 @@ export interface IDestinyMilestoneActivityPhase { * A challenge is a bonus objective, generally tacked onto Quests or Activities, * that provide additional variations on play. */ -export interface IDestinyChallengeStatus { +export interface DestinyChallengeStatus { /** The progress - including completion status - of the active challenge. */ - readonly objective: IDestinyObjectiveProgress; + readonly objective: DestinyObjectiveProgress; } -export interface IDestinyMilestoneChallengeActivity { - /** Mapped to IDestinyActivityDefinition in the manifest. */ +export interface DestinyMilestoneChallengeActivity { + /** Mapped to DestinyActivityDefinition in the manifest. */ readonly activityHash: number; - readonly challenges: IDestinyChallengeStatus[]; + readonly challenges: DestinyChallengeStatus[]; /** * If the activity has modifiers, this will be the list of modifiers that all * variants have in common. Perform lookups against @@ -9027,7 +9453,7 @@ export interface IDestinyMilestoneChallengeActivity { * than this being referred to: those are all *possible* modifiers for the activity, * not the active ones. Use only the active ones to match what's really live. * - * Mapped to IDestinyActivityModifierDefinition in the manifest. + * Mapped to DestinyActivityModifierDefinition in the manifest. */ readonly modifierHashes: number[]; /** @@ -9061,19 +9487,19 @@ export interface IDestinyMilestoneChallengeActivity { * dictionary: the order implies the ascending order of phases or progression in * this activity. */ - readonly phases: IDestinyMilestoneActivityPhase[]; + readonly phases: DestinyMilestoneActivityPhase[]; } /** * If a Milestone has one or more Vendors that are relevant to it, this will * contain information about that vendor that you can choose to show. */ -export interface IDestinyMilestoneVendor { +export interface DestinyMilestoneVendor { /** * The hash identifier of the Vendor related to this Milestone. You can show useful * things from this, such as thier Faction icon or whatever you might care about. * - * Mapped to IDestinyVendorDefinition in the manifest. + * Mapped to DestinyVendorDefinition in the manifest. */ readonly vendorHash: number; /** @@ -9083,7 +9509,7 @@ export interface IDestinyMilestoneVendor { * deprecate this too. I'm going to go with 5 months. Calling it now, 2017-09-14 at * 9:46pm PST. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly previewItemHash?: number; } @@ -9092,21 +9518,21 @@ export interface IDestinyMilestoneVendor { * Represents a category of "summary" rewards that can be earned for the Milestone * regardless of specific quest rewards that can be earned. */ -export interface IDestinyMilestoneRewardCategory { +export interface DestinyMilestoneRewardCategory { /** * Look up the relevant DestinyMilestoneDefinition, and then use rewardCategoryHash * to look up the category info in DestinyMilestoneDefinition.rewards. */ readonly rewardCategoryHash: number; /** The individual reward entries for this category, and their status. */ - readonly entries: IDestinyMilestoneRewardEntry[]; + readonly entries: DestinyMilestoneRewardEntry[]; } /** * The character-specific data for a milestone's reward entry. See * DestinyMilestoneDefinition for more information about Reward Entries. */ -export interface IDestinyMilestoneRewardEntry { +export interface DestinyMilestoneRewardEntry { /** * The identifier for the reward entry in question. It is important to look up the * related DestinyMilestoneRewardEntryDefinition to get the static details about @@ -9133,12 +9559,12 @@ export interface IDestinyMilestoneRewardEntry { * Examine the Javascript returned by https://bungie.net/sharedbundle/spasm to see * how we use this data, but be warned: the rabbit hole goes pretty deep. */ -export interface IDestinyCharacterRenderComponent { +export interface DestinyCharacterRenderComponent { /** * Custom dyes, calculated by iterating over the character's equipped items. Useful * for pre-fetching all of the dye data needed from our server. */ - readonly customDyes: IDyeReference[]; + readonly customDyes: DyeReference[]; /** * This is actually something that Spasm.js *doesn't* do right now, and that we don' * t return assets for yet. This is the data about what character customization @@ -9147,7 +9573,7 @@ export interface IDestinyCharacterRenderComponent { * hopefully someday to actually render a user's face in 3D. We'll see if we ever * end up with time for that. */ - readonly customization: IDestinyCharacterCustomization; + readonly customization: DestinyCharacterCustomization; /** * A minimal view of: * @@ -9158,7 +9584,7 @@ export interface IDestinyCharacterRenderComponent { * Combined, that should be enough to render all of the items on the equipped * character. */ - readonly peerView: IDestinyCharacterPeerView; + readonly peerView: DestinyCharacterPeerView; } /** @@ -9172,7 +9598,7 @@ export interface IDestinyCharacterRenderComponent { * icons. Others have nothing, and are only meant for 3D rendering purposes (which * we sadly do not expose yet) */ -export interface IDestinyCharacterCustomization { +export interface DestinyCharacterCustomization { readonly personality: number; readonly face: number; readonly skinColor: number; @@ -9191,24 +9617,24 @@ export interface IDestinyCharacterCustomization { * A minimal view of a character's equipped items, for the purpose of rendering a * summary screen or showing the character in 3D. */ -export interface IDestinyCharacterPeerView { - readonly equipment: IDestinyItemPeerView[]; +export interface DestinyCharacterPeerView { + readonly equipment: DestinyItemPeerView[]; } /** * Bare minimum summary information for an item, for the sake of 3D rendering the * item. */ -export interface IDestinyItemPeerView { +export interface DestinyItemPeerView { /** * The hash identifier of the item in question. Use it to look up the * DestinyInventoryItemDefinition of the item for static rendering data. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly itemHash: number; /** The list of dyes that have been applied to this item. */ - readonly dyes: IDyeReference[]; + readonly dyes: DyeReference[]; } /** @@ -9216,11 +9642,11 @@ export interface IDestinyItemPeerView { * character's current activity status, as well as activities that are available to * the user. */ -export interface IDestinyCharacterActivitiesComponent { +export interface DestinyCharacterActivitiesComponent { /** The last date that the user started playing an activity. */ readonly dateActivityStarted: string; /** The list of activities that the user can play. */ - readonly availableActivities: IDestinyActivity[]; + readonly availableActivities: DestinyActivity[]; /** * If the user is in an activity, this will be the hash of the Activity being * played. Note that you must combine this info with currentActivityModeHash to get @@ -9228,7 +9654,7 @@ export interface IDestinyCharacterActivitiesComponent { * Activities" are just maps: it's the ActivityMode that determines what type of * PVP game they're playing. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly currentActivityHash: number; /** @@ -9236,13 +9662,13 @@ export interface IDestinyCharacterActivitiesComponent { * played. Combine with currentActivityHash to give a person a full picture of what * they're doing right now. * - * Mapped to IDestinyActivityModeDefinition in the manifest. + * Mapped to DestinyActivityModeDefinition in the manifest. */ readonly currentActivityModeHash: number; /** * And the current activity's most specific mode type, if it can be found. * - * Mapped to IDestinyActivityModeDefinition in the manifest. + * Mapped to DestinyActivityModeDefinition in the manifest. */ readonly currentActivityModeType?: number; /** @@ -9250,7 +9676,7 @@ export interface IDestinyCharacterActivitiesComponent { * DestinyActivityModeDefinition being played. Combine with currentActivityHash to * give a person a full picture of what they're doing right now. * - * Mapped to IDestinyActivityModeDefinition in the manifest. + * Mapped to DestinyActivityModeDefinition in the manifest. */ readonly currentActivityModeHashes: number[]; /** All Activity Modes that apply to the current activity being played, in enum form. */ @@ -9259,14 +9685,14 @@ export interface IDestinyCharacterActivitiesComponent { * If the user is in a playlist, this is the hash identifier for the playlist that * they chose. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly currentPlaylistActivityHash?: number; /** * This will have the activity hash of the last completed story/campaign mission, * in case you care about that. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly lastCompletedStoryHash: number; } @@ -9279,12 +9705,12 @@ export interface IDestinyCharacterActivitiesComponent { * Meant to be combined with static DestinyActivityDefinition data for a full * picture of the Activity. */ -export interface IDestinyActivity { +export interface DestinyActivity { /** * The hash identifier of the Activity. Use this to look up the * DestinyActivityDefinition of the activity. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly activityHash: number; /** If true, then the activity should have a "new" indicator in the Director UI. */ @@ -9313,6 +9739,10 @@ export interface IDestinyActivity { readonly difficultyTier: DestinyActivityDifficultyTier; } +/** + * An enumeration representing the potential difficulty levels of an activity. + * Their names are... more qualitative than quantitative. + */ export const enum DestinyActivityDifficultyTier { Trivial = 0, Easy = 1, @@ -9324,15 +9754,15 @@ export const enum DestinyActivityDifficultyTier { Impossible = 7 } -export interface IDestinyBaseItemComponentSetOfuint32 { - readonly objectives: IDictionaryComponentResponse; +export interface DestinyBaseItemComponentSetOfuint32 { + readonly objectives: DictionaryComponentResponse; } /** * Items can have objectives and progression. When you request this block, you will * obtain information about any Objectives and progression tied to this item. */ -export interface IDestinyItemObjectivesComponent { +export interface DestinyItemObjectivesComponent { /** * If the item has a hard association with objectives, your progress on them will * be defined here. @@ -9340,14 +9770,14 @@ export interface IDestinyItemObjectivesComponent { * Objectives are our standard way to describe a series of tasks that have to be * completed for a reward. */ - readonly objectives: IDestinyObjectiveProgress[]; + readonly objectives: DestinyObjectiveProgress[]; /** * I may regret naming it this way - but this represents when an item has an * objective that doesn't serve a beneficial purpose, but rather is used for " * flavor" or additional information. For instance, when Emblems track specific * stats, those stats are represented as Objectives on the item. */ - readonly flavorObjective: IDestinyObjectiveProgress; + readonly flavorObjective: DestinyObjectiveProgress; /** * If we have any information on when these objectives were completed, this will be * the date of that completion. This won't be on many items, but could be @@ -9356,25 +9786,25 @@ export interface IDestinyItemObjectivesComponent { readonly dateCompleted?: string; } -export interface IDestinyCharacterRecordsComponent { - /** Mapped to IDestinyRecordDefinition in the manifest. */ +export interface DestinyCharacterRecordsComponent { + /** Mapped to DestinyRecordDefinition in the manifest. */ readonly featuredRecordHashes: number[]; - readonly records: { [key: number]: IDestinyRecordComponent }; + readonly records: { [key: number]: DestinyRecordComponent }; } -export interface IDestinyCollectiblesComponent { - readonly collectibles: { [key: number]: IDestinyCollectibleComponent }; +export interface DestinyCollectiblesComponent { + readonly collectibles: { [key: number]: DestinyCollectibleComponent }; } -export interface IDestinyItemComponentSetOfint64 { - readonly instances: IDictionaryComponentResponse; - readonly perks: IDictionaryComponentResponse; - readonly renderData: IDictionaryComponentResponse; - readonly stats: IDictionaryComponentResponse; - readonly sockets: IDictionaryComponentResponse; - readonly talentGrids: IDictionaryComponentResponse; - readonly plugStates: IDictionaryComponentResponse; - readonly objectives: IDictionaryComponentResponse; +export interface DestinyItemComponentSetOfint64 { + readonly instances: DictionaryComponentResponse; + readonly perks: DictionaryComponentResponse; + readonly renderData: DictionaryComponentResponse; + readonly stats: DictionaryComponentResponse; + readonly sockets: DictionaryComponentResponse; + readonly talentGrids: DictionaryComponentResponse; + readonly plugStates: DictionaryComponentResponse; + readonly objectives: DictionaryComponentResponse; } /** @@ -9392,21 +9822,21 @@ export interface IDestinyItemComponentSetOfint64 { * looking at the DestinyInventoryItemDefinition's definition.inventory. * isInstanceItem property. */ -export interface IDestinyItemInstanceComponent { +export interface DestinyItemInstanceComponent { /** If the item has a damage type, this is the item's current damage type. */ readonly damageType: DamageType; /** * The current damage type's hash, so you can look up localized info and icons for * it. * - * Mapped to IDestinyDamageTypeDefinition in the manifest. + * Mapped to DestinyDamageTypeDefinition in the manifest. */ readonly damageTypeHash?: number; /** * The item stat that we consider to be "primary" for the item. For instance, this * would be "Attack" for Weapons or "Defense" for armor. */ - readonly primaryStat: IDestinyStat; + readonly primaryStat: DestinyStat; /** * The Item's "Level" has the most significant bearing on its stats, such as Light * and Power. @@ -9438,13 +9868,16 @@ export interface IDestinyItemInstanceComponent { * character has not met. Use these to look up the descriptions to show in your UI * by looking up the relevant DestinyUnlockDefinitions for the hashes. * - * Mapped to IDestinyUnlockDefinition in the manifest. + * Mapped to DestinyUnlockDefinition in the manifest. */ readonly unlockHashesRequiredToEquip: number[]; /** * If you cannot equip the item, this is a flags enum that enumerates all of the * reasons why you couldn't equip the item. You may need to refine your UI further * by using unlockHashesRequiredToEquip and equipRequiredLevel. + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. */ readonly cannotEquipReason: EquipFailureReason; } @@ -9453,12 +9886,12 @@ export interface IDestinyItemInstanceComponent { * Represents a stat on an item *or* Character (NOT a Historical Stat, but a * physical attribute stat like Attack, Defense etc...) */ -export interface IDestinyStat { +export interface DestinyStat { /** * The hash identifier for the Stat. Use it to look up the DestinyStatDefinition * for static data about the stat. * - * Mapped to IDestinyStatDefinition in the manifest. + * Mapped to DestinyStatDefinition in the manifest. */ readonly statHash: number; /** The current value of the Stat. */ @@ -9477,14 +9910,14 @@ export interface IDestinyStat { * game server uses for an extremely wide range of state checks, progress storage, * and other interesting tidbits of information. */ -export interface IDestinyUnlockDefinition { +export interface DestinyUnlockDefinition { /** * Sometimes, but not frequently, these unlock flags also have human readable * information: usually when they are being directly tested for some requirement, * in which case the string is a localized description of why the requirement check * failed. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -9502,6 +9935,13 @@ export interface IDestinyUnlockDefinition { readonly redacted: boolean; } +/** + * The reasons why an item cannot be equipped, if any. Many flags can be set, or " + * None" if + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum EquipFailureReason { /** The item is/was able to be equipped. */ None = 0, @@ -9548,12 +9988,12 @@ export const enum EquipFailureReason { * Talent Grids, Sockets, and the item itself can apply Perks, which are then * summarized here for your convenience. */ -export interface IDestinyItemPerksComponent { +export interface DestinyItemPerksComponent { /** * The list of perks to display in an item tooltip - and whether or not they have * been activated. */ - readonly perks: IDestinyPerkReference[]; + readonly perks: DestinyPerkReference[]; } /** @@ -9563,14 +10003,14 @@ export interface IDestinyItemPerksComponent { * 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. */ -export interface IDestinyPerkReference { +export interface DestinyPerkReference { /** * 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. * - * Mapped to IDestinySandboxPerkDefinition in the manifest. + * Mapped to DestinySandboxPerkDefinition in the manifest. */ readonly perkHash: number; /** The icon for the perk. */ @@ -9592,7 +10032,7 @@ export interface IDestinyPerkReference { * Many items can be rendered in 3D. When you request this block, you will obtain * the custom data needed to render this specific instance of the item. */ -export interface IDestinyItemRenderComponent { +export interface DestinyItemRenderComponent { /** If you should use custom dyes on this item, it will be indicated here. */ readonly useCustomDyes: boolean; /** @@ -9615,14 +10055,14 @@ export interface IDestinyItemRenderComponent { * instance, Magazine Size - and thus these stats might not be 100% accurate * compared to what you see in-game for some stats. I know, it sucks. I hate it too. */ -export interface IDestinyItemStatsComponent { +export interface DestinyItemStatsComponent { /** * If the item has stats that it provides (damage, defense, etc...), it will be * given here. * - * Mapped to IDestinyStatDefinition in the manifest. + * Mapped to DestinyStatDefinition in the manifest. */ - readonly stats: { [key: number]: IDestinyStat }; + readonly stats: { [key: number]: DestinyStat }; } /** @@ -9633,9 +10073,9 @@ export interface IDestinyItemStatsComponent { * DestinyInventoryItemDefinition's "socket" block and elsewhere on these objects * for more details. */ -export interface IDestinyItemSocketsComponent { +export interface DestinyItemSocketsComponent { /** The list of all sockets on the item, and their status information. */ - readonly sockets: IDestinyItemSocketState[]; + readonly sockets: DestinyItemSocketState[]; } /** @@ -9645,7 +10085,7 @@ export interface IDestinyItemSocketsComponent { * If I had it to do over, this would probably have a DestinyItemPlug representing * the inserted item instead of most of these properties. :shrug: */ -export interface IDestinyItemSocketState { +export interface DestinyItemSocketState { /** * The currently active plug, if any. * @@ -9654,7 +10094,7 @@ export interface IDestinyItemSocketState { * and perks can be taken at face value on the plug item as the stats and perks it * will provide to the user/item. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly plugHash?: number; /** @@ -9684,7 +10124,7 @@ export interface IDestinyItemSocketState { * are currently allowed to be used for this socket. See the "reusablePlugs" * property, which has rendered this obsolete, for more information. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly reusablePlugHashes: number[]; /** @@ -9696,7 +10136,7 @@ export interface IDestinyItemSocketState { * itemHash and objective property for more information if you would like to * display even more data. */ - readonly plugObjectives: IDestinyObjectiveProgress[]; + readonly plugObjectives: DestinyObjectiveProgress[]; /** * If the item supports reusable plugs, this is the list of plugs that are allowed * to be used for the socket, and any relevant information about whether they are " @@ -9713,7 +10153,7 @@ export interface IDestinyItemSocketState { * plugs in your inventory to be inserted. See DestinyInventoryItemDefinition. * socket for more info. */ - readonly reusablePlugs: IDestinyItemPlug[]; + readonly reusablePlugs: DestinyItemPlug[]; } /** @@ -9738,7 +10178,7 @@ export interface IDestinyItemSocketState { * See DestinyTalentGridDefinition for more information. Brace yourself, the water' * s cold out there in the deep end. */ -export interface IDestinyItemTalentGridComponent { +export interface DestinyItemTalentGridComponent { /** * Most items don't have useful talent grids anymore, but Builds in particular * still do. @@ -9746,7 +10186,7 @@ export interface IDestinyItemTalentGridComponent { * You can use this hash to lookup the DestinyTalentGridDefinition attached to this * item, which will be crucial for understanding the node values on the item. * - * Mapped to IDestinyTalentGridDefinition in the manifest. + * Mapped to DestinyTalentGridDefinition in the manifest. */ readonly talentGridHash: number; /** @@ -9756,7 +10196,7 @@ export interface IDestinyItemTalentGridComponent { * though each node may have multiple "steps" which indicate the actual bonuses and * visual representation of that node. */ - readonly nodes: IDestinyTalentNode[]; + readonly nodes: DestinyTalentNode[]; /** * Indicates whether the talent grid on this item is completed, and thus whether it * should have a gold border around it. @@ -9771,7 +10211,7 @@ export interface IDestinyItemTalentGridComponent { * that the item can gain experience. Thresholds of experience are what determines * whether and when a talent node can be activated. */ - readonly gridProgression: IDestinyProgression; + readonly gridProgression: DestinyProgression; } /** @@ -9795,7 +10235,7 @@ export interface IDestinyItemTalentGridComponent { * content matches that of the server responses before showing or making decisions * based on talent grid data. */ -export interface IDestinyTalentNode { +export interface DestinyTalentNode { /** * The index of the Talent Node being referred to (an index into * DestinyTalentGridDefinition.nodes[]). CONTENT VERSION DEPENDENT. @@ -9827,7 +10267,7 @@ export interface IDestinyTalentNode { * If the node has material requirements to be activated, this is the list of those * requirements. */ - readonly materialsToUpgrade: IDestinyMaterialRequirement[]; + readonly materialsToUpgrade: DestinyMaterialRequirement[]; /** * The progression level required on the Talent Grid in order to be able to * activate this talent node. Talent Grids have their own Progression - similar to @@ -9852,7 +10292,7 @@ export interface IDestinyTalentNode { * it's related to and the character equipping the item. This returns data about * those stat bonuses. */ - readonly nodeStatsBlock: IDestinyTalentNodeStatBlock; + readonly nodeStatsBlock: DestinyTalentNodeStatBlock; } export const enum DestinyTalentNodeState { @@ -9877,12 +10317,12 @@ export const enum DestinyTalentNodeState { * it's related to and the character equipping the item. This returns data about * those stat bonuses. */ -export interface IDestinyTalentNodeStatBlock { +export interface DestinyTalentNodeStatBlock { /** * The stat benefits conferred when this talent node is activated for the current * Step that is active on the node. */ - readonly currentStepStats: IDestinyStat[]; + readonly currentStepStats: DestinyStat[]; /** * This is a holdover from the old days of Destiny 1, when a node could be * activated multiple times, conferring multiple steps worth of benefits: you would @@ -9892,7 +10332,7 @@ export interface IDestinyTalentNodeStatBlock { * I hesitate to remove this property while the ability for designers to make such * a talent grid still exists. Whether you want to show it is up to you. */ - readonly nextStepStats: IDestinyStat[]; + readonly nextStepStats: DestinyStat[]; } /** @@ -9904,12 +10344,12 @@ export interface IDestinyTalentNodeStatBlock { * and return information about the plug aside from any specific Socket into which * it could be inserted. */ -export interface IDestinyItemPlugComponent { +export interface DestinyItemPlugComponent { /** * The hash identifier of the DestinyInventoryItemDefinition that represents this * plug. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly plugItemHash: number; /** @@ -9923,7 +10363,7 @@ export interface IDestinyItemPlugComponent { * progressDescription property. Refer to the plug's itemHash and objective * property for more information if you would like to display even more data. */ - readonly plugObjectives: IDestinyObjectiveProgress[]; + readonly plugObjectives: DestinyObjectiveProgress[]; /** If true, this plug has met all of its insertion requirements. Big if true. */ readonly canInsert: boolean; /** If true, this plug will provide its benefits while inserted. */ @@ -9960,7 +10400,7 @@ export interface IDestinyItemPlugComponent { * it if you have already created your own lookup from prior GetCharacter/ * GetProfile calls. */ -export interface IDestinyCurrenciesComponent { +export interface DestinyCurrenciesComponent { /** * A dictionary - keyed by the item's hash identifier ( * DestinyInventoryItemDefinition), and whose value is the amount of that item you @@ -9969,7 +10409,7 @@ export interface IDestinyCurrenciesComponent { * This allows you to see whether the requesting character can afford any given * purchase/action without having to re-create this list itself. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly itemQuantities: { [key: number]: number }; } @@ -9978,50 +10418,50 @@ export interface IDestinyCurrenciesComponent { * The response contract for GetDestinyCharacter, with components that can be * returned for character and item-level data. */ -export interface IDestinyCharacterResponse { +export interface DestinyCharacterResponse { /** * The character-level non-equipped inventory items. * * COMPONENT TYPE: CharacterInventories */ - readonly inventory: ISingleComponentResponse; + readonly inventory: SingleComponentResponse; /** * Base information about the character in question. * * COMPONENT TYPE: Characters */ - readonly character: ISingleComponentResponse; + readonly character: SingleComponentResponse; /** * Character progression data, including Milestones. * * COMPONENT TYPE: CharacterProgressions */ - readonly progressions: ISingleComponentResponse; + readonly progressions: SingleComponentResponse; /** * Character rendering data - a minimal set of information about equipment and dyes * used for rendering. * * COMPONENT TYPE: CharacterRenderData */ - readonly renderData: ISingleComponentResponse; + readonly renderData: SingleComponentResponse; /** * Activity data - info about current activities available to the player. * * COMPONENT TYPE: CharacterActivities */ - readonly activities: ISingleComponentResponse; + readonly activities: SingleComponentResponse; /** * Equipped items on the character. * * COMPONENT TYPE: CharacterEquipment */ - readonly equipment: ISingleComponentResponse; + readonly equipment: SingleComponentResponse; /** * Items available from Kiosks that are available to this specific character. * * COMPONENT TYPE: Kiosks */ - readonly kiosks: ISingleComponentResponse; + readonly kiosks: SingleComponentResponse; /** * When sockets refer to reusable Plug Sets (see DestinyPlugSetDefinition for more * info), this is the set of plugs and their states that are scoped to this @@ -10032,20 +10472,20 @@ export interface IDestinyCharacterResponse { * * COMPONENT TYPE: ItemSockets */ - readonly plugSets: ISingleComponentResponse; + readonly plugSets: SingleComponentResponse; /** COMPONENT TYPE: PresentationNodes */ - readonly presentationNodes: ISingleComponentResponse; + readonly presentationNodes: SingleComponentResponse; /** COMPONENT TYPE: Records */ - readonly records: ISingleComponentResponse; + readonly records: SingleComponentResponse; /** COMPONENT TYPE: Collectibles */ - readonly collectibles: ISingleComponentResponse; + readonly collectibles: SingleComponentResponse; /** * The set of components belonging to the player's instanced items. * * COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component * types.] */ - readonly itemComponents: IDestinyItemComponentSetOfint64; + readonly itemComponents: DestinyItemComponentSetOfint64; /** * The set of components belonging to the player's UNinstanced items. Because * apparently now those too can have information relevant to the character's state. @@ -10053,14 +10493,14 @@ export interface IDestinyCharacterResponse { * COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component * types.] */ - readonly uninstancedItemComponents: IDestinyBaseItemComponentSetOfuint32; + readonly uninstancedItemComponents: DestinyBaseItemComponentSetOfuint32; /** * A "lookup" convenience component that can be used to quickly check if the * character has access to items that can be used for purchasing. * * COMPONENT TYPE: CurrencyLookups */ - readonly currencyLookups: ISingleComponentResponse; + readonly currencyLookups: SingleComponentResponse; } /** @@ -10068,7 +10508,7 @@ export interface IDestinyCharacterResponse { * components are relevant for an item that doesn't have an "itemInstanceId": for * those, get your information from the DestinyInventoryDefinition. */ -export interface IDestinyItemResponse { +export interface DestinyItemResponse { /** * If the item is on a character, this will return the ID of the character that is * holding the item. @@ -10079,37 +10519,37 @@ export interface IDestinyItemResponse { * * COMPONENT TYPE: ItemCommonData */ - readonly item: ISingleComponentResponse; + readonly item: SingleComponentResponse; /** * Basic instance data for the item. * * COMPONENT TYPE: ItemInstances */ - readonly instance: ISingleComponentResponse; + readonly instance: SingleComponentResponse; /** * Information specifically about the item's objectives. * * COMPONENT TYPE: ItemObjectives */ - readonly objectives: ISingleComponentResponse; + readonly objectives: SingleComponentResponse; /** * Information specifically about the perks currently active on the item. * * COMPONENT TYPE: ItemPerks */ - readonly perks: ISingleComponentResponse; + readonly perks: SingleComponentResponse; /** * Information about how to render the item in 3D. * * COMPONENT TYPE: ItemRenderData */ - readonly renderData: ISingleComponentResponse; + readonly renderData: SingleComponentResponse; /** * Information about the computed stats of the item: power, defense, etc... * * COMPONENT TYPE: ItemStats */ - readonly stats: ISingleComponentResponse; + readonly stats: SingleComponentResponse; /** * Information about the talent grid attached to the item. Talent nodes can provide * a variety of benefits and abilities, and in Destiny 2 are used almost @@ -10117,7 +10557,7 @@ export interface IDestinyItemResponse { * * COMPONENT TYPE: ItemTalentGrids */ - readonly talentGrid: ISingleComponentResponse; + readonly talentGrid: SingleComponentResponse; /** * Information about the sockets of the item: which are currently active, what * potential sockets you could have and the stats/abilities/perks you can gain from @@ -10125,11 +10565,11 @@ export interface IDestinyItemResponse { * * COMPONENT TYPE: ItemSockets */ - readonly sockets: ISingleComponentResponse; + readonly sockets: SingleComponentResponse; } /** A response containing all of the components for all requested vendors. */ -export interface IDestinyVendorsResponse { +export interface DestinyVendorsResponse { /** * For Vendors being returned, this will give you the information you need to group * them and order them in the same way that the Bungie Companion app performs @@ -10137,14 +10577,14 @@ export interface IDestinyVendorsResponse { * * COMPONENT TYPE: Vendors */ - readonly vendorGroups: ISingleComponentResponse; + readonly vendorGroups: SingleComponentResponse; /** * The base properties of the vendor. These are keyed by the Vendor Hash, so you * will get one Vendor Component per vendor returned. * * COMPONENT TYPE: Vendors */ - readonly vendors: IDictionaryComponentResponse; + readonly vendors: DictionaryComponentResponse; /** * Categories that the vendor has available, and references to the sales therein. * These are keyed by the Vendor Hash, so you will get one Categories Component per @@ -10152,7 +10592,7 @@ export interface IDestinyVendorsResponse { * * COMPONENT TYPE: VendorCategories */ - readonly categories: IDictionaryComponentResponse; + readonly categories: DictionaryComponentResponse; /** * Sales, keyed by the vendorItemIndex of the item being sold. These are keyed by * the Vendor Hash, so you will get one Sale Item Set Component per vendor returned. @@ -10163,7 +10603,7 @@ export interface IDestinyVendorsResponse { * * COMPONENT TYPE: VendorSales */ - readonly sales: IDictionaryComponentResponse; + readonly sales: DictionaryComponentResponse; /** * The set of item detail components, one set of item components per Vendor. These * are keyed by the Vendor Hash, so you will get one Item Component Set per vendor @@ -10173,14 +10613,14 @@ export interface IDestinyVendorsResponse { * will have whatever item-level components you requested (Sockets, Stats, Instance * data etc...) per item being sold by the vendor. */ - readonly itemComponents: { [key: number]: IDestinyItemComponentSetOfint32 }; + readonly itemComponents: { [key: number]: DestinyItemComponentSetOfint32 }; /** * A "lookup" convenience component that can be used to quickly check if the * character has access to items that can be used for purchasing. * * COMPONENT TYPE: CurrencyLookups */ - readonly currencyLookups: ISingleComponentResponse; + readonly currencyLookups: SingleComponentResponse; } /** @@ -10188,9 +10628,9 @@ export interface IDestinyVendorsResponse { * by categorizations that Bungie has deemed to be interesting, in the order in * which both the groups and the vendors within that group should be rendered. */ -export interface IDestinyVendorGroupComponent { +export interface DestinyVendorGroupComponent { /** The ordered list of groups being returned. */ - readonly groups: IDestinyVendorGroup[]; + readonly groups: DestinyVendorGroup[]; } /** @@ -10200,24 +10640,49 @@ export interface IDestinyVendorGroupComponent { * How do we figure out this order? It's a long story, and will likely get more * complicated over time. */ -export interface IDestinyVendorGroup { - /** Mapped to IDestinyVendorGroupDefinition in the manifest. */ +export interface DestinyVendorGroup { + /** Mapped to DestinyVendorGroupDefinition in the manifest. */ readonly vendorGroupHash: number; /** * The ordered list of vendors within a particular group. * - * Mapped to IDestinyVendorDefinition in the manifest. + * Mapped to DestinyVendorDefinition in the manifest. */ readonly vendorHashes: number[]; } /** This component contains essential/summary information about the vendor. */ -export interface IDestinyVendorComponent { +export interface DestinyVendorComponent { + /** + * If True, you can purchase from the Vendor. + * + * Theoretically, Vendors can be restricted from selling items. In practice, none + * do that (yet?). + */ + readonly canPurchase: boolean; + /** + * If the Vendor has a related Reputation, this is the Progression data that + * represents the character's Reputation level with this Vendor. + */ + readonly progression: DestinyProgression; + /** + * An index into the vendor definition's "locations" property array, indicating + * which location they are at currently. If -1, then the vendor has no known + * location (and you may choose not to show them in your UI as a result. I mean, it' + * s your bag honey) + */ + readonly vendorLocationIndex: number; + /** + * If this vendor has a seasonal rank, this will be the calculated value of that + * rank. How nice is that? I mean, that's pretty sweeet. It's a whole 32 bit + * integer. + */ + readonly seasonalRank?: number; /** * The unique identifier for the vendor. Use it to look up their * DestinyVendorDefinition. * - * Mapped to IDestinyVendorDefinition in the manifest. + * Mapped to DestinyVendorDefinition in the manifest. */ readonly vendorHash: number; /** @@ -10240,31 +10705,6 @@ export interface IDestinyVendorComponent { * If False, they may not actually be visible in the world at the moment. */ readonly enabled: boolean; - /** - * If True, you can purchase from the Vendor. - * - * Theoretically, Vendors can be restricted from selling items. In practice, none - * do that (yet?). - */ - readonly canPurchase: boolean; - /** - * If the Vendor has a related Reputation, this is the Progression data that - * represents the character's Reputation level with this Vendor. - */ - readonly progression: IDestinyProgression; - /** - * An index into the vendor definition's "locations" property array, indicating - * which location they are at currently. If -1, then the vendor has no known - * location (and you may choose not to show them in your UI as a result. I mean, it' - * s your bag honey) - */ - readonly vendorLocationIndex: number; - /** - * If this vendor has a seasonal rank, this will be the calculated value of that - * rank. How nice is that? I mean, that's pretty sweeet. It's a whole 32 bit - * integer. - */ - readonly seasonalRank?: number; } /** @@ -10276,18 +10716,18 @@ export interface IDestinyVendorComponent { * Version dependent. Be sure to check that your content is up to date before using * this data. This is an unfortunate, but permanent, limitation of Vendor data. */ -export interface IDestinyVendorCategoriesComponent { +export interface DestinyVendorCategoriesComponent { /** * The list of categories for items that the vendor sells, in rendering order. * * These categories each point to a "display category" in the displayCategories * property of the DestinyVendorDefinition, as opposed to the other categories. */ - readonly categories: IDestinyVendorCategory[]; + readonly categories: DestinyVendorCategory[]; } /** Information about the category and items currently sold in that category. */ -export interface IDestinyVendorCategory { +export interface DestinyVendorCategory { /** * An index into the DestinyVendorDefinition.displayCategories property, so you can * grab the display data for this category. @@ -10302,18 +10742,8 @@ export interface IDestinyVendorCategory { readonly itemIndexes: number[]; } -/** - * The collection of all items currently being sold by a specific Vendor and - * visible to the given character for which the request was made. - */ -export interface IDestinyVendorSaleItemSetComponent { - /** - * The items being sold by this vendor, keyed by the vendorItemIndex of the item - * being sold. (because showing sale items depends on the ordering dictated by the - * categories being shown - see DestinyVendorCategoryComponent - this is a - * dictionary for quick lookup capability.) - */ - readonly saleItems: { [key: number]: IDestinyVendorSaleItemComponent }; +export interface PersonalDestinyVendorSaleItemSetComponent { + readonly saleItems: { [key: number]: DestinyVendorSaleItemComponent }; } /** @@ -10325,44 +10755,15 @@ export interface IDestinyVendorSaleItemSetComponent { * request additional components such as ItemInstances, ItemPerks etc... and * acquire them from the DestinyVendorResponse's "items" property. */ -export interface IDestinyVendorSaleItemComponent { - /** - * The index into the DestinyVendorDefinition.itemList property. Note that this - * means Vendor data *is* Content Version dependent: make sure you have the latest - * content before you use Vendor data, or these indexes may mismatch. - * - * Most systems avoid this problem, but Vendors is one area where we are unable to - * reasonably avoid content dependency at the moment. - */ - readonly vendorItemIndex: number; - /** - * The hash of the item being sold, as a quick shortcut for looking up the - * DestinyInventoryItemDefinition of the sale item. - * - * Mapped to IDestinyInventoryItemDefinition in the manifest. - */ - readonly itemHash: number; - /** - * If populated, this is the hash of the item whose icon (and other secondary - * styles, but *not* the human readable strings) should override whatever icons/ - * styles are on the item being sold. - * - * If you don't do this, certain items whose styles are being overridden by - * socketed items - such as the "Recycle Shader" item - would show whatever their - * default icon/style is, and it wouldn't be pretty or look accurate. - * - * Mapped to IDestinyInventoryItemDefinition in the manifest. - */ - readonly overrideStyleItemHash?: number; - /** How much of the item you'll be getting. */ - readonly quantity: number; +export interface DestinyVendorSaleItemComponent { /** * A flag indicating whether the requesting character can buy the item, and if not * the reasons why the character can't buy it. + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. */ readonly saleStatus: VendorItemStatus; - /** A summary of the current costs of the item. */ - readonly costs: IDestinyItemQuantity[]; /** * If you can't buy the item due to a complex character state, these will be hashes * for DestinyUnlockDefinitions that you can check to see messages regarding the @@ -10373,7 +10774,7 @@ export interface IDestinyVendorSaleItemComponent { * Prefer using failureIndexes instead. These are provided for informational * purposes, but have largely been supplanted by failureIndexes. * - * Mapped to IDestinyUnlockDefinition in the manifest. + * Mapped to DestinyUnlockDefinition in the manifest. */ readonly requiredUnlocks: number[]; /** @@ -10383,7 +10784,7 @@ export interface IDestinyVendorSaleItemComponent { * Prefer using failureIndexes instead. These are provided for informational * purposes, but have largely been supplanted by failureIndexes. */ - readonly unlockStatuses: IDestinyUnlockStatus[]; + readonly unlockStatuses: DestinyUnlockStatus[]; /** * Indexes in to the "failureStrings" lookup table in DestinyVendorDefinition for * the given Vendor. Gives some more reliable failure information for why you can't @@ -10402,8 +10803,43 @@ export interface IDestinyVendorSaleItemComponent { * * Determining how you want to represent these in your own app (or if you even want * to) is an exercise left for the reader. + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. */ readonly augments: DestinyVendorItemState; + /** + * The index into the DestinyVendorDefinition.itemList property. Note that this + * means Vendor data *is* Content Version dependent: make sure you have the latest + * content before you use Vendor data, or these indexes may mismatch. + * + * Most systems avoid this problem, but Vendors is one area where we are unable to + * reasonably avoid content dependency at the moment. + */ + readonly vendorItemIndex: number; + /** + * The hash of the item being sold, as a quick shortcut for looking up the + * DestinyInventoryItemDefinition of the sale item. + * + * Mapped to DestinyInventoryItemDefinition in the manifest. + */ + readonly itemHash: number; + /** + * If populated, this is the hash of the item whose icon (and other secondary + * styles, but *not* the human readable strings) should override whatever icons/ + * styles are on the item being sold. + * + * If you don't do this, certain items whose styles are being overridden by + * socketed items - such as the "Recycle Shader" item - would show whatever their + * default icon/style is, and it wouldn't be pretty or look accurate. + * + * Mapped to DestinyInventoryItemDefinition in the manifest. + */ + readonly overrideStyleItemHash?: number; + /** How much of the item you'll be getting. */ + readonly quantity: number; + /** A summary of the current costs of the item. */ + readonly costs: DestinyItemQuantity[]; /** * If this item has its own custom date where it may be removed from the Vendor's * rotation, this is that date. @@ -10417,6 +10853,10 @@ export interface IDestinyVendorSaleItemComponent { readonly overrideNextRefreshDate?: string; } +/** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum VendorItemStatus { Success = 0, NoInventorySpace = 1, @@ -10442,7 +10882,7 @@ export const enum VendorItemStatus { * sometimes provide interesting human-readable information in their related * DestinyUnlockDefinition. */ -export interface IDestinyUnlockStatus { +export interface DestinyUnlockStatus { /** * The hash identifier for the Unlock Flag. Use to lookup DestinyUnlockDefinition * for static data. Not all unlocks have human readable data - in fact, most don't. @@ -10450,13 +10890,21 @@ export interface IDestinyUnlockStatus { * readable data, you might be able to infer the meaning of an unlock flag with a * bit of experimentation... * - * Mapped to IDestinyUnlockDefinition in the manifest. + * Mapped to DestinyUnlockDefinition in the manifest. */ readonly unlockHash: number; /** Whether the unlock flag is set. */ readonly isSet: boolean; } +/** + * The possible states of Destiny Profile Records. IMPORTANT: Any given item can + * theoretically have many of these states simultaneously: as a result, this was + * altered to be a flags enumeration/bitmask for v3.2.0. + * + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum DestinyVendorItemState { /** There are no augments on the item. */ None = 0, @@ -10502,60 +10950,198 @@ export const enum DestinyVendorItemState { NexusAttention = 512 } -export interface IDestinyItemComponentSetOfint32 { - readonly instances: IDictionaryComponentResponse; - readonly perks: IDictionaryComponentResponse; - readonly renderData: IDictionaryComponentResponse; - readonly stats: IDictionaryComponentResponse; - readonly sockets: IDictionaryComponentResponse; - readonly talentGrids: IDictionaryComponentResponse; - readonly plugStates: IDictionaryComponentResponse; - readonly objectives: IDictionaryComponentResponse; +export interface DestinyItemComponentSetOfint32 { + readonly instances: DictionaryComponentResponse; + readonly perks: DictionaryComponentResponse; + readonly renderData: DictionaryComponentResponse; + readonly stats: DictionaryComponentResponse; + readonly sockets: DictionaryComponentResponse; + readonly talentGrids: DictionaryComponentResponse; + readonly plugStates: DictionaryComponentResponse; + readonly objectives: DictionaryComponentResponse; } /** A response containing all of the components for a vendor. */ -export interface IDestinyVendorResponse { +export interface DestinyVendorResponse { /** * The base properties of the vendor. * * COMPONENT TYPE: Vendors */ - readonly vendor: ISingleComponentResponse; + readonly vendor: SingleComponentResponse; /** * Categories that the vendor has available, and references to the sales therein. * * COMPONENT TYPE: VendorCategories */ - readonly categories: ISingleComponentResponse; + readonly categories: SingleComponentResponse; /** * Sales, keyed by the vendorItemIndex of the item being sold. * * COMPONENT TYPE: VendorSales */ - readonly sales: IDictionaryComponentResponse; + readonly sales: DictionaryComponentResponse; /** * Item components, keyed by the vendorItemIndex of the active sale items. * * COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component * types.] */ - readonly itemComponents: IDestinyItemComponentSetOfint32; + readonly itemComponents: DestinyItemComponentSetOfint32; /** * A "lookup" convenience component that can be used to quickly check if the * character has access to items that can be used for purchasing. * * COMPONENT TYPE: CurrencyLookups */ - readonly currencyLookups: ISingleComponentResponse; + readonly currencyLookups: SingleComponentResponse; +} + +/** + * A response containing all valid components for the public Vendors endpoint. + * + * It is a decisively smaller subset of data compared to what we can get when we + * know the specific user making the request. + * + * If you want any of the other data - item details, whether or not you can buy it, + * etc... you'll have to call in the context of a character. I know, sad but true. + */ +export interface DestinyPublicVendorsResponse { + /** + * For Vendors being returned, this will give you the information you need to group + * them and order them in the same way that the Bungie Companion app performs + * grouping. It will automatically be returned if you request the Vendors component. + * + * COMPONENT TYPE: Vendors + */ + readonly vendorGroups: SingleComponentResponse; + /** + * The base properties of the vendor. These are keyed by the Vendor Hash, so you + * will get one Vendor Component per vendor returned. + * + * COMPONENT TYPE: Vendors + */ + readonly vendors: DictionaryComponentResponse; + /** + * Categories that the vendor has available, and references to the sales therein. + * These are keyed by the Vendor Hash, so you will get one Categories Component per + * vendor returned. + * + * COMPONENT TYPE: VendorCategories + */ + readonly categories: DictionaryComponentResponse; + /** + * Sales, keyed by the vendorItemIndex of the item being sold. These are keyed by + * the Vendor Hash, so you will get one Sale Item Set Component per vendor returned. + * + * Note that within the Sale Item Set component, the sales are themselves keyed by + * the vendorSaleIndex, so you can relate it to the corrent sale item definition + * within the Vendor's definition. + * + * COMPONENT TYPE: VendorSales + */ + readonly sales: DictionaryComponentResponse; +} + +/** + * This component contains essential/summary information about the vendor from the + * perspective of a character-agnostic view. + */ +export interface DestinyPublicVendorComponent { + /** + * The unique identifier for the vendor. Use it to look up their + * DestinyVendorDefinition. + * + * Mapped to DestinyVendorDefinition in the manifest. + */ + readonly vendorHash: number; + /** + * The date when this vendor's inventory will next rotate/refresh. + * + * Note that this is distinct from the date ranges that the vendor is visible/ + * available in-game: this field indicates the specific time when the vendor's + * available items refresh and rotate, regardless of whether the vendor is actually + * available at that time. Unfortunately, these two values may be (and are, for the + * case of important vendors like Xur) different. + * + * Issue https://github.com/Bungie-net/api/issues/353 is tracking a fix to start + * providing visibility date ranges where possible in addition to this refresh date, + * so that all important dates for vendors are available for use. + */ + readonly nextRefreshDate: string; + /** + * If True, the Vendor is currently accessible. + * + * If False, they may not actually be visible in the world at the moment. + */ + readonly enabled: boolean; +} + +export interface PublicDestinyVendorSaleItemSetComponent { + readonly saleItems: { [key: number]: DestinyPublicVendorSaleItemComponent }; +} + +/** + * Has character-agnostic information about an item being sold by a vendor. + * + * Note that if you want instance, stats, etc... data for the item, you'll have to + * request additional components such as ItemInstances, ItemPerks etc... and + * acquire them from the DestinyVendorResponse's "items" property. For most of + * these, however, you'll have to ask for it in context of a specific character. + */ +export interface DestinyPublicVendorSaleItemComponent { + /** + * The index into the DestinyVendorDefinition.itemList property. Note that this + * means Vendor data *is* Content Version dependent: make sure you have the latest + * content before you use Vendor data, or these indexes may mismatch. + * + * Most systems avoid this problem, but Vendors is one area where we are unable to + * reasonably avoid content dependency at the moment. + */ + readonly vendorItemIndex: number; + /** + * The hash of the item being sold, as a quick shortcut for looking up the + * DestinyInventoryItemDefinition of the sale item. + * + * Mapped to DestinyInventoryItemDefinition in the manifest. + */ + readonly itemHash: number; + /** + * If populated, this is the hash of the item whose icon (and other secondary + * styles, but *not* the human readable strings) should override whatever icons/ + * styles are on the item being sold. + * + * If you don't do this, certain items whose styles are being overridden by + * socketed items - such as the "Recycle Shader" item - would show whatever their + * default icon/style is, and it wouldn't be pretty or look accurate. + * + * Mapped to DestinyInventoryItemDefinition in the manifest. + */ + readonly overrideStyleItemHash?: number; + /** How much of the item you'll be getting. */ + readonly quantity: number; + /** A summary of the current costs of the item. */ + readonly costs: DestinyItemQuantity[]; + /** + * If this item has its own custom date where it may be removed from the Vendor's + * rotation, this is that date. + * + * Note that there's not actually any guarantee that it will go away: it could be + * chosen again and end up still being in the Vendor's sale items! But this is the + * next date where that test will occur, and is also the date that the game shows + * for availability on things like Bounties being sold. So it's the best we can + * give. + */ + readonly overrideNextRefreshDate?: string; } /** * Returns the detailed information about a Collectible Presentation Node and any * Collectibles that are direct descendants. */ -export interface IDestinyCollectibleNodeDetailResponse { +export interface DestinyCollectibleNodeDetailResponse { /** COMPONENT TYPE: Collectibles */ - readonly collectibles: ISingleComponentResponse; + readonly collectibles: SingleComponentResponse; /** * Item components, keyed by the item hash of the items pointed at collectibles * found under the requested Presentation Node. @@ -10574,27 +11160,27 @@ export interface IDestinyCollectibleNodeDetailResponse { * COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component * types.] */ - readonly collectibleItemComponents: IDestinyItemComponentSetOfuint32; + readonly collectibleItemComponents: DestinyItemComponentSetOfuint32; } -export interface IDestinyItemComponentSetOfuint32 { - readonly instances: IDictionaryComponentResponse; - readonly perks: IDictionaryComponentResponse; - readonly renderData: IDictionaryComponentResponse; - readonly stats: IDictionaryComponentResponse; - readonly sockets: IDictionaryComponentResponse; - readonly talentGrids: IDictionaryComponentResponse; - readonly plugStates: IDictionaryComponentResponse; - readonly objectives: IDictionaryComponentResponse; +export interface DestinyItemComponentSetOfuint32 { + readonly instances: DictionaryComponentResponse; + readonly perks: DictionaryComponentResponse; + readonly renderData: DictionaryComponentResponse; + readonly stats: DictionaryComponentResponse; + readonly sockets: DictionaryComponentResponse; + readonly talentGrids: DictionaryComponentResponse; + readonly plugStates: DictionaryComponentResponse; + readonly objectives: DictionaryComponentResponse; } /** The results of a bulk Equipping operation performed through the Destiny API. */ -export interface IDestinyEquipItemResults { - readonly equipResults: IDestinyEquipItemResult[]; +export interface DestinyEquipItemResults { + readonly equipResults: DestinyEquipItemResult[]; } /** The results of an Equipping operation performed through the Destiny API. */ -export interface IDestinyEquipItemResult { +export interface DestinyEquipItemResult { /** * The instance ID of the item in question (all items that can be equipped must, * but definition, be Instanced and thus have an Instance ID that you can use to @@ -10611,7 +11197,7 @@ export interface IDestinyEquipItemResult { * Note that, while you *can* point to a socket that represents infusion, you will * receive an error if you attempt to do so. Come on guys, let's play nice. */ -export interface IDestinyInsertPlugsRequestEntry { +export interface DestinyInsertPlugsRequestEntry { /** * The index into the socket array, which identifies the specific socket being * operated on. We also need to know the socketArrayType in order to uniquely @@ -10636,20 +11222,29 @@ export interface IDestinyInsertPlugsRequestEntry { readonly plugItemHash: number; } +/** + * If you look in the DestinyInventoryItemDefinition's "sockets" property, you'll + * see that there are two types of sockets: intrinsic, and "socketEntry." + * + * Unfortunately, because Intrinsic sockets are a whole separate array, it is no + * longer sufficient to know the index into that array to know which socket we're + * talking about. You have to know whether it's in the default "socketEntries" or + * if it's in the "intrinsic" list. + */ export const enum DestinySocketArrayType { Default = 0, Intrinsic = 1 } -export interface IDestinyItemChangeResponse { - readonly item: IDestinyItemResponse; +export interface DestinyItemChangeResponse { + readonly item: DestinyItemResponse; /** Items that appeared in the inventory possibly as a result of an action. */ - readonly addedInventoryItems: IDestinyItemComponent[]; + readonly addedInventoryItems: DestinyItemComponent[]; /** Items that disappeared from the inventory possibly as a result of an action. */ - readonly removedInventoryItems: IDestinyItemComponent[]; + readonly removedInventoryItems: DestinyItemComponent[]; } -export interface IDestinyPostGameCarnageReportData { +export interface DestinyPostGameCarnageReportData { /** Date and time for the activity. */ readonly period: string; /** @@ -10658,26 +11253,26 @@ export interface IDestinyPostGameCarnageReportData { */ readonly startingPhaseIndex?: number; /** Details about the activity. */ - readonly activityDetails: IDestinyHistoricalStatsActivity; + readonly activityDetails: DestinyHistoricalStatsActivity; /** Collection of players and their data for this activity. */ - readonly entries: IDestinyPostGameCarnageReportEntry[]; + readonly entries: DestinyPostGameCarnageReportEntry[]; /** Collection of stats for the player in this activity. */ - readonly teams: IDestinyPostGameCarnageReportTeamEntry[]; + readonly teams: DestinyPostGameCarnageReportTeamEntry[]; } /** Summary information about the activity that was played. */ -export interface IDestinyHistoricalStatsActivity { +export interface DestinyHistoricalStatsActivity { /** * The unique hash identifier of the DestinyActivityDefinition that was played. If * I had this to do over, it'd be named activityHash. Too late now. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly referenceId: number; /** * The unique hash identifier of the DestinyActivityDefinition that was played. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly directorActivityHash: number; /** @@ -10702,30 +11297,30 @@ export interface IDestinyHistoricalStatsActivity { readonly isPrivate: boolean; } -export interface IDestinyPostGameCarnageReportEntry { +export interface DestinyPostGameCarnageReportEntry { /** Standing of the player */ readonly standing: number; /** Score of the player if available */ - readonly score: IDestinyHistoricalStatsValue; + readonly score: DestinyHistoricalStatsValue; /** Identity details of the player */ - readonly player: IDestinyPlayer; + readonly player: DestinyPlayer; /** ID of the player's character used in the activity. */ readonly characterId: string; /** Collection of stats for the player in this activity. */ - readonly values: { [key: string]: IDestinyHistoricalStatsValue }; + readonly values: { [key: string]: DestinyHistoricalStatsValue }; /** Extended data extracted from the activity blob. */ - readonly extended: IDestinyPostGameCarnageReportExtendedData; + readonly extended: DestinyPostGameCarnageReportExtendedData; } -export interface IDestinyHistoricalStatsValue { +export interface DestinyHistoricalStatsValue { /** Unique ID for this stat */ readonly statId: string; /** Basic stat value. */ - readonly basic: IDestinyHistoricalStatsValuePair; + readonly basic: DestinyHistoricalStatsValuePair; /** Per game average for the statistic, if applicable */ - readonly pga: IDestinyHistoricalStatsValuePair; + readonly pga: DestinyHistoricalStatsValuePair; /** Weighted value of the stat if a weight greater than 1 has been assigned. */ - readonly weighted: IDestinyHistoricalStatsValuePair; + readonly weighted: DestinyHistoricalStatsValuePair; /** * When a stat represents the best, most, longest, fastest or some other personal * best, the actual activity ID where that personal best was established is @@ -10734,19 +11329,19 @@ export interface IDestinyHistoricalStatsValue { readonly activityId?: string; } -export interface IDestinyHistoricalStatsValuePair { +export interface DestinyHistoricalStatsValuePair { /** Raw value of the statistic */ readonly value: number; /** Localized formated version of the value. */ readonly displayValue: string; } -export interface IDestinyPlayer { +export interface DestinyPlayer { /** * Details about the player as they are known in game (platform display name, * Destiny emblem) */ - readonly destinyUserInfo: IUserInfoCard; + readonly destinyUserInfo: UserInfoCard; /** Class of the character if applicable and available. */ readonly characterClass: string; readonly classHash: number; @@ -10761,7 +11356,7 @@ export interface IDestinyPlayer { * if the player has marked their credential private, or does not have a BungieNet * account. */ - readonly bungieNetUserInfo: IUserInfoCard; + readonly bungieNetUserInfo: UserInfoCard; /** * Current clan name for the player. This value may be null or an empty string if * the user does not have a clan. @@ -10780,31 +11375,31 @@ export interface IDestinyPlayer { readonly emblemHash: number; } -export interface IDestinyPostGameCarnageReportExtendedData { +export interface DestinyPostGameCarnageReportExtendedData { /** List of weapons and their perspective values. */ - readonly weapons: IDestinyHistoricalWeaponStats[]; + readonly weapons: DestinyHistoricalWeaponStats[]; /** Collection of stats for the player in this activity. */ - readonly values: { [key: string]: IDestinyHistoricalStatsValue }; + readonly values: { [key: string]: DestinyHistoricalStatsValue }; } -export interface IDestinyHistoricalWeaponStats { +export interface DestinyHistoricalWeaponStats { /** * The hash ID of the item definition that describes the weapon. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly referenceId: number; /** Collection of stats for the period. */ - readonly values: { [key: string]: IDestinyHistoricalStatsValue }; + readonly values: { [key: string]: DestinyHistoricalStatsValue }; } -export interface IDestinyPostGameCarnageReportTeamEntry { +export interface DestinyPostGameCarnageReportTeamEntry { /** Integer ID for the team. */ readonly teamId: number; /** Team's standing relative to other teams. */ - readonly standing: IDestinyHistoricalStatsValue; + readonly standing: DestinyHistoricalStatsValue; /** Score earned by the team */ - readonly score: IDestinyHistoricalStatsValue; + readonly score: DestinyHistoricalStatsValue; /** Alpha or Bravo */ readonly teamName: string; } @@ -10819,10 +11414,10 @@ export interface IDestinyPostGameCarnageReportTeamEntry { * combination of the reasonHash *and* the associated ReasonCategory's hash: there * are some reasons defined under multiple categories. */ -export interface IDestinyReportReasonCategoryDefinition { - readonly displayProperties: IDestinyDisplayPropertiesDefinition; +export interface DestinyReportReasonCategoryDefinition { + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** The specific reasons for the report under this category. */ - readonly reasons: { [key: number]: IDestinyReportReasonDefinition }; + readonly reasons: { [key: number]: DestinyReportReasonDefinition }; /** * The unique identifier for this entity. Guaranteed to be unique for the type of * entity, but not globally. @@ -10846,16 +11441,16 @@ export interface IDestinyReportReasonCategoryDefinition { * means that report reasons' reasonHash are not globally unique: and indeed, * entries like "Other" are defined under most categories for example. */ -export interface IDestinyReportReasonDefinition { +export interface DestinyReportReasonDefinition { /** * The identifier for the reason: they are only guaranteed unique under the * Category in which they are found. */ readonly reasonHash: number; - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; } -export interface IDestinyHistoricalStatsDefinition { +export interface DestinyHistoricalStatsDefinition { /** Unique programmer friendly ID for this stat */ readonly statId: string; /** Statistic group */ @@ -10935,36 +11530,36 @@ export const enum UnitType { CompletionReason = 13 } -export interface IDestinyLeaderboard { +export interface DestinyLeaderboard { readonly statId: string; - readonly entries: IDestinyLeaderboardEntry[]; + readonly entries: DestinyLeaderboardEntry[]; } -export interface IDestinyLeaderboardEntry { +export interface DestinyLeaderboardEntry { /** Where this player ranks on the leaderboard. A value of 1 is the top rank. */ readonly rank: number; /** Identity details of the player */ - readonly player: IDestinyPlayer; + readonly player: DestinyPlayer; /** ID of the player's best character for the reported stat. */ readonly characterId: string; /** Value of the stat for this player */ - readonly value: IDestinyHistoricalStatsValue; + readonly value: DestinyHistoricalStatsValue; } -export interface IDestinyClanAggregateStat { +export interface DestinyClanAggregateStat { /** The id of the mode of stats (allPvp, allPvE, etc) */ readonly mode: DestinyActivityModeType; /** The id of the stat */ readonly statId: string; /** Value of the stat for this player */ - readonly value: IDestinyHistoricalStatsValue; + readonly value: DestinyHistoricalStatsValue; } /** * The results of a search for Destiny content. This will be improved on over time, * I've been doing some experimenting to see what might be useful. */ -export interface IDestinyEntitySearchResult { +export interface DestinyEntitySearchResult { /** * A list of suggested words that might make for better search results, based on * the text searched for. @@ -10975,14 +11570,14 @@ export interface IDestinyEntitySearchResult { * by something vaguely resembling "relevance". Hopefully this will get better in * the future. */ - readonly results: ISearchResultOfDestinyEntitySearchResultItem; + readonly results: SearchResultOfDestinyEntitySearchResultItem; } -export interface ISearchResultOfDestinyEntitySearchResultItem { - readonly results: IDestinyEntitySearchResultItem[]; +export interface SearchResultOfDestinyEntitySearchResultItem { + readonly results: DestinyEntitySearchResultItem[]; readonly totalResults: number; readonly hasMore: boolean; - readonly query: IPagedQuery; + readonly query: PagedQuery; readonly replacementContinuationToken: string; /** * If useTotalResults is true, then totalResults represents an accurate count. @@ -11000,7 +11595,7 @@ export interface ISearchResultOfDestinyEntitySearchResultItem { } /** An individual Destiny Entity returned from the entity search. */ -export interface IDestinyEntitySearchResultItem { +export interface DestinyEntitySearchResultItem { /** * The hash identifier of the entity. You will use this to look up the * DestinyDefinition relevant for the entity found. @@ -11016,7 +11611,7 @@ export interface IDestinyEntitySearchResultItem { * Basic display properties on the entity, so you don't have to look up the * definition to show basic results for the item. */ - readonly displayProperties: IDestinyDisplayPropertiesDefinition; + readonly displayProperties: DestinyDisplayPropertiesDefinition; /** * The ranking value for sorting that we calculated using our relevance formula. * This will hopefully get better with time and iteration. @@ -11024,16 +11619,16 @@ export interface IDestinyEntitySearchResultItem { readonly weight: number; } -export interface IDestinyHistoricalStatsByPeriod { - readonly allTime: { [key: string]: IDestinyHistoricalStatsValue }; - readonly allTimeTier1: { [key: string]: IDestinyHistoricalStatsValue }; - readonly allTimeTier2: { [key: string]: IDestinyHistoricalStatsValue }; - readonly allTimeTier3: { [key: string]: IDestinyHistoricalStatsValue }; - readonly daily: IDestinyHistoricalStatsPeriodGroup[]; - readonly monthly: IDestinyHistoricalStatsPeriodGroup[]; +export interface DestinyHistoricalStatsByPeriod { + readonly allTime: { [key: string]: DestinyHistoricalStatsValue }; + readonly allTimeTier1: { [key: string]: DestinyHistoricalStatsValue }; + readonly allTimeTier2: { [key: string]: DestinyHistoricalStatsValue }; + readonly allTimeTier3: { [key: string]: DestinyHistoricalStatsValue }; + readonly daily: DestinyHistoricalStatsPeriodGroup[]; + readonly monthly: DestinyHistoricalStatsPeriodGroup[]; } -export interface IDestinyHistoricalStatsPeriodGroup { +export interface DestinyHistoricalStatsPeriodGroup { /** * Period for the group. If the stat periodType is day, then this will have a * specific day. If the type is monthly, then this value will be the first day of @@ -11041,53 +11636,53 @@ export interface IDestinyHistoricalStatsPeriodGroup { */ readonly period: string; /** If the period group is for a specific activity, this property will be set. */ - readonly activityDetails: IDestinyHistoricalStatsActivity; + readonly activityDetails: DestinyHistoricalStatsActivity; /** Collection of stats for the period. */ - readonly values: { [key: string]: IDestinyHistoricalStatsValue }; + readonly values: { [key: string]: DestinyHistoricalStatsValue }; } -export interface IDestinyHistoricalStatsAccountResult { - readonly mergedDeletedCharacters: IDestinyHistoricalStatsWithMerged; - readonly mergedAllCharacters: IDestinyHistoricalStatsWithMerged; - readonly characters: IDestinyHistoricalStatsPerCharacter[]; +export interface DestinyHistoricalStatsAccountResult { + readonly mergedDeletedCharacters: DestinyHistoricalStatsWithMerged; + readonly mergedAllCharacters: DestinyHistoricalStatsWithMerged; + readonly characters: DestinyHistoricalStatsPerCharacter[]; } -export interface IDestinyHistoricalStatsWithMerged { - readonly results: { [key: string]: IDestinyHistoricalStatsByPeriod }; - readonly merged: IDestinyHistoricalStatsByPeriod; +export interface DestinyHistoricalStatsWithMerged { + readonly results: { [key: string]: DestinyHistoricalStatsByPeriod }; + readonly merged: DestinyHistoricalStatsByPeriod; } -export interface IDestinyHistoricalStatsPerCharacter { +export interface DestinyHistoricalStatsPerCharacter { readonly characterId: string; readonly deleted: boolean; - readonly results: { [key: string]: IDestinyHistoricalStatsByPeriod }; - readonly merged: IDestinyHistoricalStatsByPeriod; + readonly results: { [key: string]: DestinyHistoricalStatsByPeriod }; + readonly merged: DestinyHistoricalStatsByPeriod; } -export interface IDestinyActivityHistoryResults { +export interface DestinyActivityHistoryResults { /** List of activities, the most recent activity first. */ - readonly activities: IDestinyHistoricalStatsPeriodGroup[]; + readonly activities: DestinyHistoricalStatsPeriodGroup[]; } -export interface IDestinyHistoricalWeaponStatsData { +export interface DestinyHistoricalWeaponStatsData { /** List of weapons and their perspective values. */ - readonly weapons: IDestinyHistoricalWeaponStats[]; + readonly weapons: DestinyHistoricalWeaponStats[]; } -export interface IDestinyAggregateActivityResults { +export interface DestinyAggregateActivityResults { /** List of all activities the player has participated in. */ - readonly activities: IDestinyAggregateActivityStats[]; + readonly activities: DestinyAggregateActivityStats[]; } -export interface IDestinyAggregateActivityStats { +export interface DestinyAggregateActivityStats { /** * Hash ID that can be looked up in the DestinyActivityTable. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly activityHash: number; /** Collection of stats for the player in this activity. */ - readonly values: { [key: string]: IDestinyHistoricalStatsValue }; + readonly values: { [key: string]: DestinyHistoricalStatsValue }; } /** @@ -11097,7 +11692,7 @@ export interface IDestinyAggregateActivityStats { * responses, both for brevity of response and for caching purposes. If you really * need this data, hit the Milestone Content endpoint. */ -export interface IDestinyMilestoneContent { +export interface DestinyMilestoneContent { /** The "About this Milestone" text from the Firehose. */ readonly about: string; /** The Current Status of the Milestone, as driven by the Firehose. */ @@ -11108,7 +11703,7 @@ export interface IDestinyMilestoneContent { * If DPS has defined items related to this Milestone, they can categorize those * items in the Firehose. That data will then be returned as item categories here. */ - readonly itemCategories: IDestinyMilestoneContentItemCategory[]; + readonly itemCategories: DestinyMilestoneContentItemCategory[]; } /** @@ -11116,9 +11711,9 @@ export interface IDestinyMilestoneContent { * items. These are built in our content management system, and thus aren't the * same as programmatically generated rewards. */ -export interface IDestinyMilestoneContentItemCategory { +export interface DestinyMilestoneContentItemCategory { readonly title: string; - /** Mapped to IDestinyInventoryItemDefinition in the manifest. */ + /** Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly itemHashes: number[]; } @@ -11128,20 +11723,20 @@ export interface IDestinyMilestoneContentItemCategory { * milestone, which is basically a checklist of things to do in the game. Think of * this as GetPublicAdvisors 3.0, for those who used the Destiny 1 API. */ -export interface IDestinyPublicMilestone { +export interface DestinyPublicMilestone { /** * The hash identifier for the milestone. Use it to look up the * DestinyMilestoneDefinition for static data about the Milestone. * - * Mapped to IDestinyMilestoneDefinition in the manifest. + * Mapped to DestinyMilestoneDefinition in the manifest. */ readonly milestoneHash: number; /** * A milestone not need have even a single quest, but if there are active quests * they will be returned here. */ - readonly availableQuests: IDestinyPublicMilestoneQuest[]; - readonly activities: IDestinyPublicMilestoneChallengeActivity[]; + readonly availableQuests: DestinyPublicMilestoneQuest[]; + readonly activities: DestinyPublicMilestoneChallengeActivity[]; /** * Sometimes milestones - or activities active in milestones - will have relevant * vendors. These are the vendors that are currently relevant. @@ -11155,7 +11750,7 @@ export interface IDestinyPublicMilestone { * shown that relate to this milestone, potentially along with other interesting * data. */ - readonly vendors: IDestinyPublicMilestoneVendor[]; + readonly vendors: DestinyPublicMilestoneVendor[]; /** If known, this is the date when the Milestone started/became active. */ readonly startDate?: string; /** If known, this is the date when the Milestone will expire/recycle/end. */ @@ -11167,7 +11762,7 @@ export interface IDestinyPublicMilestone { readonly order: number; } -export interface IDestinyPublicMilestoneQuest { +export interface DestinyPublicMilestoneQuest { /** * Quests are defined as Items in content. As such, this is the hash identifier of * the DestinyInventoryItemDefinition that represents this quest. It will have @@ -11176,20 +11771,20 @@ export interface IDestinyPublicMilestoneQuest { * item's DestinyInventoryItemDefinition.setData property, and themselves are Items * with their own renderable data. * - * Mapped to IDestinyMilestoneDefinition in the manifest. + * Mapped to DestinyMilestoneDefinition in the manifest. */ readonly questItemHash: number; /** * A milestone need not have an active activity, but if there is one it will be * returned here, along with any variant and additional information. */ - readonly activity: IDestinyPublicMilestoneActivity; + readonly activity: DestinyPublicMilestoneActivity; /** * For the given quest there could be 0-to-Many challenges: mini quests that you * can perform in the course of doing this quest, that may grant you rewards and * benefits. */ - readonly challenges: IDestinyPublicMilestoneChallenge[]; + readonly challenges: DestinyPublicMilestoneChallenge[]; } /** @@ -11200,13 +11795,13 @@ export interface IDestinyPublicMilestoneQuest { * don't seem appropriate to you, let us know and I'll buy you a beer if we ever * meet up in person. */ -export interface IDestinyPublicMilestoneActivity { +export interface DestinyPublicMilestoneActivity { /** * The hash identifier of the activity that's been chosen to be considered the * canonical "conceptual" activity definition. This may have many variants, defined * herein. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly activityHash: number; /** @@ -11214,14 +11809,14 @@ export interface IDestinyPublicMilestoneActivity { * hashes to the DestinyActivityModifierDefinition that defines the modifier being * applied. * - * Mapped to IDestinyActivityModifierDefinition in the manifest. + * Mapped to DestinyActivityModifierDefinition in the manifest. */ readonly modifierHashes: number[]; /** * Every relevant variation of this conceptual activity, including the conceptual * activity itself, have variants defined here. */ - readonly variants: IDestinyPublicMilestoneActivityVariant[]; + readonly variants: DestinyPublicMilestoneActivityVariant[]; /** * The hash identifier of the most specific Activity Mode under which this activity * is played. This is useful for situations where the activity in question is - for @@ -11229,7 +11824,7 @@ export interface IDestinyPublicMilestoneActivity { * under. If it's a playlist, this will be less specific: but hopefully useful in * some way. * - * Mapped to IDestinyActivityModeDefinition in the manifest. + * Mapped to DestinyActivityModeDefinition in the manifest. */ readonly activityModeHash?: number; /** @@ -11240,7 +11835,7 @@ export interface IDestinyPublicMilestoneActivity { } /** Represents a variant of an activity that's relevant to a milestone. */ -export interface IDestinyPublicMilestoneActivityVariant { +export interface DestinyPublicMilestoneActivityVariant { /** * The hash identifier of this activity variant. Examine the activity's definition * in the Manifest database to determine what makes it a distinct variant. Usually @@ -11255,7 +11850,7 @@ export interface IDestinyPublicMilestoneActivityVariant { * under. If it's a playlist, this will be less specific: but hopefully useful in * some way. * - * Mapped to IDestinyActivityModeDefinition in the manifest. + * Mapped to DestinyActivityModeDefinition in the manifest. */ readonly activityModeHash?: number; /** @@ -11269,13 +11864,13 @@ export interface IDestinyPublicMilestoneActivityVariant { * A Milestone can have many Challenges. Challenges are just extra Objectives that * provide a fun way to mix-up play and provide extra rewards. */ -export interface IDestinyPublicMilestoneChallenge { +export interface DestinyPublicMilestoneChallenge { /** * The objective for the Challenge, which should have human-readable data about * what needs to be done to accomplish the objective. Use this hash to look up the * DestinyObjectiveDefinition. * - * Mapped to IDestinyObjectiveDefinition in the manifest. + * Mapped to DestinyObjectiveDefinition in the manifest. */ readonly objectiveHash: number; /** @@ -11283,13 +11878,13 @@ export interface IDestinyPublicMilestoneChallenge { * hash. Use it to look up the DestinyActivityDefinition for additional data to * show. * - * Mapped to IDestinyActivityDefinition in the manifest. + * Mapped to DestinyActivityDefinition in the manifest. */ readonly activityHash?: number; } -export interface IDestinyPublicMilestoneChallengeActivity { - /** Mapped to IDestinyActivityDefinition in the manifest. */ +export interface DestinyPublicMilestoneChallengeActivity { + /** Mapped to DestinyActivityDefinition in the manifest. */ readonly activityHash: number; readonly challengeObjectiveHashes: number[]; /** @@ -11302,7 +11897,7 @@ export interface IDestinyPublicMilestoneChallengeActivity { * than this being referred to: those are all *possible* modifiers for the activity, * not the active ones. Use only the active ones to match what's really live. * - * Mapped to IDestinyActivityModifierDefinition in the manifest. + * Mapped to DestinyActivityModifierDefinition in the manifest. */ readonly modifierHashes: number[]; /** @@ -11333,12 +11928,12 @@ export interface IDestinyPublicMilestoneChallengeActivity { readonly booleanActivityOptions: { [key: number]: boolean }; } -export interface IDestinyPublicMilestoneVendor { +export interface DestinyPublicMilestoneVendor { /** * The hash identifier of the Vendor related to this Milestone. You can show useful * things from this, such as thier Faction icon or whatever you might care about. * - * Mapped to IDestinyVendorDefinition in the manifest. + * Mapped to DestinyVendorDefinition in the manifest. */ readonly vendorHash: number; /** @@ -11348,7 +11943,7 @@ export interface IDestinyPublicMilestoneVendor { * deprecate this too. I'm going to go with 5 months. Calling it now, 2017-09-14 at * 9:46pm PST. * - * Mapped to IDestinyInventoryItemDefinition in the manifest. + * Mapped to DestinyInventoryItemDefinition in the manifest. */ readonly previewItemHash?: number; } @@ -11359,7 +11954,7 @@ export const enum AwaType { InsertPlugs = 1 } -export interface IAwaInitializeResponse { +export interface AwaInitializeResponse { /** * ID used to get the token. Present this ID to the user as it will identify this * specific request on their device. @@ -11375,7 +11970,7 @@ export const enum AwaUserSelection { Approved = 2 } -export interface IAwaAuthorizationResult { +export interface AwaAuthorizationResult { /** * Indication of how the user responded to the request. If the value is "Approved" * the actionToken will contain the token that can be presented when performing the @@ -11418,19 +12013,19 @@ export const enum AwaResponseReason { * currently active in the Activity, regardless of an individual character's * progress in it. */ -export interface IDestinyPublicActivityStatus { +export interface DestinyPublicActivityStatus { /** * Active Challenges for the activity, if any - represented as hashes for * DestinyObjectiveDefinitions. * - * Mapped to IDestinyObjectiveDefinition in the manifest. + * Mapped to DestinyObjectiveDefinition in the manifest. */ readonly challengeObjectiveHashes: number[]; /** * The active modifiers on this activity, if any - represented as hashes for * DestinyActivityModifierDefinitions. * - * Mapped to IDestinyActivityModifierDefinition in the manifest. + * Mapped to DestinyActivityModifierDefinition in the manifest. */ readonly modifierHashes: number[]; /** @@ -11444,5 +12039,5 @@ export interface IDestinyPublicActivityStatus { * represent an abstract concept of what you will get for a reward rather than the * specific items you may obtain. */ - readonly rewardTooltipItems: IDestinyItemQuantity[]; + readonly rewardTooltipItems: DestinyItemQuantity[]; } diff --git a/src/type-definitions/fireteam/index.ts b/src/type-definitions/fireteam/index.ts index ce8fa5a..30180d1 100644 --- a/src/type-definitions/fireteam/index.ts +++ b/src/type-definitions/fireteam/index.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. diff --git a/src/type-definitions/fireteam/interfaces.ts b/src/type-definitions/fireteam/interfaces.ts index b545220..54cc8dd 100644 --- a/src/type-definitions/fireteam/interfaces.ts +++ b/src/type-definitions/fireteam/interfaces.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. @@ -11,10 +11,10 @@ */ import { - IPagedQuery + PagedQuery } from '../common'; import { - IUserInfoCard + UserInfoCard } from '../user/interfaces'; export const enum FireteamActivityType { @@ -27,7 +27,8 @@ export const enum FireteamActivityType { Gambit = 6, BlindWell = 7, EscalationProtocol = 8, - Forge = 9 + Forge = 9, + Reckoning = 10 } export const enum FireteamDateRange { @@ -57,11 +58,11 @@ export const enum FireteamSlotSearch { HasOpenPlayerOrAltSlots = 2 } -export interface ISearchResultOfFireteamSummary { - readonly results: IFireteamSummary[]; +export interface SearchResultOfFireteamSummary { + readonly results: FireteamSummary[]; readonly totalResults: number; readonly hasMore: boolean; - readonly query: IPagedQuery; + readonly query: PagedQuery; readonly replacementContinuationToken: string; /** * If useTotalResults is true, then totalResults represents an accurate count. @@ -78,7 +79,7 @@ export interface ISearchResultOfFireteamSummary { readonly useTotalResults: boolean; } -export interface IFireteamSummary { +export interface FireteamSummary { readonly fireteamId: string; readonly groupId: string; readonly platform: FireteamPlatform; @@ -99,11 +100,11 @@ export interface IFireteamSummary { readonly datePlayerModified: string; } -export interface ISearchResultOfFireteamResponse { - readonly results: IFireteamResponse[]; +export interface SearchResultOfFireteamResponse { + readonly results: FireteamResponse[]; readonly totalResults: number; readonly hasMore: boolean; - readonly query: IPagedQuery; + readonly query: PagedQuery; readonly replacementContinuationToken: string; /** * If useTotalResults is true, then totalResults represents an accurate count. @@ -120,15 +121,15 @@ export interface ISearchResultOfFireteamResponse { readonly useTotalResults: boolean; } -export interface IFireteamResponse { - readonly Summary: IFireteamSummary; - readonly Members: IFireteamMember[]; - readonly Alternates: IFireteamMember[]; +export interface FireteamResponse { + readonly Summary: FireteamSummary; + readonly Members: FireteamMember[]; + readonly Alternates: FireteamMember[]; } -export interface IFireteamMember { - readonly destinyUserInfo: IUserInfoCard; - readonly bungieNetUserInfo: IUserInfoCard; +export interface FireteamMember { + readonly destinyUserInfo: UserInfoCard; + readonly bungieNetUserInfo: UserInfoCard; readonly characterId: string; readonly dateJoined: string; readonly hasMicrophone: boolean; diff --git a/src/type-definitions/forum/index.ts b/src/type-definitions/forum/index.ts index ce8fa5a..30180d1 100644 --- a/src/type-definitions/forum/index.ts +++ b/src/type-definitions/forum/index.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. diff --git a/src/type-definitions/forum/interfaces.ts b/src/type-definitions/forum/interfaces.ts index 10d0758..91a0110 100644 --- a/src/type-definitions/forum/interfaces.ts +++ b/src/type-definitions/forum/interfaces.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. @@ -11,19 +11,23 @@ */ import { - IGeneralUser + GeneralUser } from '../user/interfaces'; import { - IGroupResponse + GroupResponse } from '../groupv2/interfaces'; import { - IIgnoreResponse, - ITagResponse + IgnoreResponse, + TagResponse } from '../platform'; import { - IPagedQuery + PagedQuery } from '../common'; +/** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum ForumTopicsCategoryFiltersEnum { None = 0, Links = 1, @@ -60,18 +64,18 @@ export const enum ForumPostSortEnum { OldestFirst = 1 } -export interface IPostSearchResponse { - readonly relatedPosts: IPostResponse[]; - readonly authors: IGeneralUser[]; - readonly groups: IGroupResponse[]; - readonly searchedTags: ITagResponse[]; - readonly polls: IPollResponse[]; - readonly recruitmentDetails: IForumRecruitmentDetail[]; +export interface PostSearchResponse { + readonly relatedPosts: PostResponse[]; + readonly authors: GeneralUser[]; + readonly groups: GroupResponse[]; + readonly searchedTags: TagResponse[]; + readonly polls: PollResponse[]; + readonly recruitmentDetails: ForumRecruitmentDetail[]; readonly availablePages?: number; - readonly results: IPostResponse[]; + readonly results: PostResponse[]; readonly totalResults: number; readonly hasMore: boolean; - readonly query: IPagedQuery; + readonly query: PagedQuery; readonly replacementContinuationToken: string; /** * If useTotalResults is true, then totalResults represents an accurate count. @@ -88,7 +92,7 @@ export interface IPostSearchResponse { readonly useTotalResults: boolean; } -export interface IPostResponse { +export interface PostResponse { readonly lastReplyTimestamp: string; readonly IsPinned: boolean; readonly urlMediaType: ForumMediaType; @@ -101,7 +105,7 @@ export interface IPostResponse { readonly userHasMutedPost: boolean; readonly latestReplyPostId: string; readonly latestReplyAuthorId: string; - readonly ignoreStatus: IIgnoreResponse; + readonly ignoreStatus: IgnoreResponse; readonly locale: string; } @@ -121,13 +125,13 @@ export const enum ForumPostPopularity { Hot = 5 } -export interface IPollResponse { +export interface PollResponse { readonly topicId: string; - readonly results: IPollResult[]; + readonly results: PollResult[]; readonly totalVotes: number; } -export interface IPollResult { +export interface PollResult { readonly answerText: string; readonly answerSlot: number; readonly lastVoteDate: string; @@ -135,7 +139,7 @@ export interface IPollResult { readonly requestingUserVoted: boolean; } -export interface IForumRecruitmentDetail { +export interface ForumRecruitmentDetail { readonly topicId: string; readonly microphoneRequired: boolean; readonly intensity: ForumRecruitmentIntensityLabel; @@ -144,7 +148,7 @@ export interface IForumRecruitmentDetail { readonly conversationId?: string; readonly playerSlotsTotal: number; readonly playerSlotsRemaining: number; - readonly Fireteam: IGeneralUser[]; + readonly Fireteam: GeneralUser[]; readonly kickedPlayerIds: string[]; } @@ -160,11 +164,6 @@ export const enum ForumRecruitmentToneLabel { Rowdy = 2 } -export interface ISaveMessageResult { - readonly conversationId: string; - readonly messageId: string; -} - export const enum CommunityContentSortMode { Trending = 0, Latest = 1, diff --git a/src/type-definitions/groupv2/index.ts b/src/type-definitions/groupv2/index.ts index ce8fa5a..30180d1 100644 --- a/src/type-definitions/groupv2/index.ts +++ b/src/type-definitions/groupv2/index.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. diff --git a/src/type-definitions/groupv2/interfaces.ts b/src/type-definitions/groupv2/interfaces.ts index 5b9e34c..7585717 100644 --- a/src/type-definitions/groupv2/interfaces.ts +++ b/src/type-definitions/groupv2/interfaces.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. @@ -12,22 +12,22 @@ import { BungieMembershipType, - IPagedQuery, + PagedQuery, PlatformErrorCodes } from '../common'; import { - IDestinyProgression + DestinyProgression } from '../destiny2/interfaces'; import { - IUserInfoCard, - IUserMembership + UserInfoCard, + UserMembership } from '../user/interfaces'; -export interface IGroupResponse { - readonly detail: IGroupV2; - readonly founder: IGroupMember; +export interface GroupResponse { + readonly detail: GroupV2; + readonly founder: GroupMember; readonly alliedIds: string[]; - readonly parentGroup: IGroupV2; + readonly parentGroup: GroupV2; readonly allianceStatus: GroupAllianceStatus; readonly groupJoinInviteCount: number; /** @@ -35,16 +35,16 @@ export interface IGroupResponse { * group. Note that because of account linking, a user can sometimes be part of a * clan more than once. As such, this returns the highest member type available. */ - readonly currentUserMemberMap: { [key: number]: IGroupMember }; + readonly currentUserMemberMap: { [key in BungieMembershipType]: GroupMember }; /** * This property will be populated if the authenticated user is an applicant or has * an outstanding invitation to join. Note that because of account linking, a user * can sometimes be part of a clan more than once. */ - readonly currentUserPotentialMemberMap: { [key: number]: IGroupPotentialMember }; + readonly currentUserPotentialMemberMap: { [key in BungieMembershipType]: GroupPotentialMember }; } -export interface IGroupV2 { +export interface GroupV2 { readonly groupId: string; readonly name: string; readonly groupType: GroupType; @@ -71,8 +71,8 @@ export interface IGroupV2 { readonly conversationId: string; readonly enableInvitationMessagingForAdmins: boolean; readonly banExpireDate?: string; - readonly features: IGroupFeatures; - readonly clanInfo: IGroupV2ClanInfoAndInvestment; + readonly features: GroupFeatures; + readonly clanInfo: GroupV2ClanInfoAndInvestment; } export const enum GroupType { @@ -103,7 +103,7 @@ export const enum GroupPostPublicity { Private = 2 } -export interface IGroupFeatures { +export interface GroupFeatures { readonly maximumMembers: number; /** * Maximum number of groups of this type a typical membership may join. For example, @@ -111,6 +111,10 @@ export interface IGroupFeatures { * join one clan per Destiny membership. */ readonly maximumMembershipsOfGroupType: number; + /** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ readonly capabilities: Capabilities; readonly membershipTypes: BungieMembershipType[]; /** @@ -163,6 +167,10 @@ export interface IGroupFeatures { readonly joinLevel: RuntimeGroupMemberType; } +/** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum Capabilities { None = 0, Leaderboards = 1, @@ -174,12 +182,23 @@ export const enum Capabilities { Alliances = 64 } +/** + * Used for setting the guided game permission level override (admins and founders + * can always host guided games). + */ export const enum HostGuidedGamesPermissionLevel { None = 0, Beginner = 1, Member = 2 } +/** + * The member levels used by all V2 Groups API. Individual group types use their + * own mappings in their native storage (general uses BnetDbGroupMemberType and D2 + * clans use ClanMemberLevel), but they are all translated to this in the runtime + * api. These runtime values should NEVER be stored anywhere, so the values can be + * changed as necessary. + */ export const enum RuntimeGroupMemberType { None = 0, Beginner = 1, @@ -190,13 +209,13 @@ export const enum RuntimeGroupMemberType { } /** The same as GroupV2ClanInfo, but includes any investment data. */ -export interface IGroupV2ClanInfoAndInvestment { - readonly d2ClanProgressions: { [key: number]: IDestinyProgression }; +export interface GroupV2ClanInfoAndInvestment { + readonly d2ClanProgressions: { [key: number]: DestinyProgression }; readonly clanCallsign: string; - readonly clanBannerData: IClanBanner; + readonly clanBannerData: ClanBanner; } -export interface IClanBanner { +export interface ClanBanner { readonly decalId: number; readonly decalColorId: number; readonly decalBackgroundColorId: number; @@ -206,12 +225,13 @@ export interface IClanBanner { readonly gonfalonDetailColorId: number; } -export interface IGroupMember { +export interface GroupMember { readonly memberType: RuntimeGroupMemberType; readonly isOnline: boolean; + readonly lastOnlineStatusChange: string; readonly groupId: string; - readonly destinyUserInfo: IUserInfoCard; - readonly bungieNetUserInfo: IUserInfoCard; + readonly destinyUserInfo: UserInfoCard; + readonly bungieNetUserInfo: UserInfoCard; readonly joinDate: string; } @@ -221,11 +241,11 @@ export const enum GroupAllianceStatus { Child = 2 } -export interface IGroupPotentialMember { +export interface GroupPotentialMember { readonly potentialStatus: GroupPotentialMemberStatus; readonly groupId: string; - readonly destinyUserInfo: IUserInfoCard; - readonly bungieNetUserInfo: IUserInfoCard; + readonly destinyUserInfo: UserInfoCard; + readonly bungieNetUserInfo: UserInfoCard; readonly joinDate: string; } @@ -257,7 +277,7 @@ export const enum GroupDateRange { * * If you pass these, you will get a useless InvalidParameters error. */ -export interface IGroupQuery { +export interface GroupQuery { readonly name: string; readonly groupType: GroupType; readonly creationDate: GroupDateRange; @@ -270,38 +290,12 @@ export interface IGroupQuery { readonly requestContinuationToken: string; } -export interface IGroupNameSearchRequest { +export interface GroupNameSearchRequest { readonly groupName: string; readonly groupType: GroupType; } -export interface IGroupAction { - /** Type of group, either Bungie.net hosted group, or a game services hosted clan. */ - readonly groupType: GroupType; - readonly name: string; - readonly about: string; - readonly motto: string; - readonly theme: string; - readonly avatarImageIndex: number; - readonly tags: string; - readonly isPublic: boolean; - readonly membershipOption: MembershipOption; - readonly isPublicTopicAdminOnly: boolean; - readonly isDefaultPostPublic: boolean; - readonly allowChat: boolean; - readonly isDefaultPostAlliance: boolean; - readonly chatSecurity: ChatSecuritySetting; - readonly callsign: string; - readonly locale: string; - readonly homepage: GroupHomepage; - /** - * When operation needs a platform specific account ID for the present user, use - * this property. In particular, groupType of Clan requires this value to be set. - */ - readonly platformMembershipType: BungieMembershipType; -} - -export interface IGroupEditAction { +export interface GroupEditAction { readonly name: string; readonly about: string; readonly motto: string; @@ -320,7 +314,7 @@ export interface IGroupEditAction { readonly defaultPublicity?: number; } -export interface IGroupOptionsEditAction { +export interface GroupOptionsEditAction { /** * Minimum Member Level allowed to invite new members to group * @@ -371,28 +365,28 @@ export interface IGroupOptionsEditAction { readonly JoinLevel?: number; } -export interface IGroupOptionalConversationAddRequest { +export interface GroupOptionalConversationAddRequest { readonly chatName: string; readonly chatSecurity: ChatSecuritySetting; } -export interface IGroupOptionalConversationEditRequest { +export interface GroupOptionalConversationEditRequest { readonly chatEnabled?: boolean; readonly chatName: string; readonly chatSecurity?: number; } -export interface IGroupBanRequest { +export interface GroupBanRequest { readonly comment: string; readonly length: IgnoreLength; } -export interface IGroupApplicationRequest { +export interface GroupApplicationRequest { readonly message: string; } -export interface IGroupApplicationListRequest { - readonly memberships: IUserMembership[]; +export interface GroupApplicationListRequest { + readonly memberships: UserMembership[]; readonly message: string; } @@ -402,7 +396,7 @@ export const enum GroupsForMemberFilter { NonFounded = 2 } -export interface IGroupTheme { +export interface GroupTheme { readonly name: string; readonly folder: string; readonly description: string; @@ -412,7 +406,7 @@ export interface IGroupTheme { * A small infocard of group information, usually used for when a list of groups * are returned */ -export interface IGroupV2Card { +export interface GroupV2Card { readonly groupId: string; readonly name: string; readonly groupType: GroupType; @@ -422,8 +416,12 @@ export interface IGroupV2Card { readonly memberCount: number; readonly locale: string; readonly membershipOption: MembershipOption; + /** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ readonly capabilities: Capabilities; - readonly clanInfo: IGroupV2ClanInfo; + readonly clanInfo: GroupV2ClanInfo; readonly avatarPath: string; readonly theme: string; } @@ -432,9 +430,9 @@ export interface IGroupV2Card { * This contract contains clan-specific group information. It does not include any * investment data. */ -export interface IGroupV2ClanInfo { +export interface GroupV2ClanInfo { readonly clanCallsign: string; - readonly clanBannerData: IClanBanner; + readonly clanBannerData: ClanBanner; } export const enum GroupSortBy { @@ -444,11 +442,11 @@ export const enum GroupSortBy { Id = 3 } -export interface IGroupSearchResponse { - readonly results: IGroupV2Card[]; +export interface GroupSearchResponse { + readonly results: GroupV2Card[]; readonly totalResults: number; readonly hasMore: boolean; - readonly query: IPagedQuery; + readonly query: PagedQuery; readonly replacementContinuationToken: string; /** * If useTotalResults is true, then totalResults represents an accurate count. @@ -465,7 +463,7 @@ export interface IGroupSearchResponse { readonly useTotalResults: boolean; } -export interface IGroupOptionalConversation { +export interface GroupOptionalConversation { readonly groupId: string; readonly conversationId: string; readonly chatEnabled: boolean; @@ -473,15 +471,11 @@ export interface IGroupOptionalConversation { readonly chatSecurity: ChatSecuritySetting; } -export interface IGroupCreationResponse { - readonly groupId: string; -} - -export interface ISearchResultOfGroupMember { - readonly results: IGroupMember[]; +export interface SearchResultOfGroupMember { + readonly results: GroupMember[]; readonly totalResults: number; readonly hasMore: boolean; - readonly query: IPagedQuery; + readonly query: PagedQuery; readonly replacementContinuationToken: string; /** * If useTotalResults is true, then totalResults represents an accurate count. @@ -498,8 +492,8 @@ export interface ISearchResultOfGroupMember { readonly useTotalResults: boolean; } -export interface IGroupMemberLeaveResult { - readonly group: IGroupV2; +export interface GroupMemberLeaveResult { + readonly group: GroupV2; readonly groupDeleted: boolean; } @@ -518,11 +512,11 @@ export const enum IgnoreLength { ThirtyDays = 11 } -export interface ISearchResultOfGroupBan { - readonly results: IGroupBan[]; +export interface SearchResultOfGroupBan { + readonly results: GroupBan[]; readonly totalResults: number; readonly hasMore: boolean; - readonly query: IPagedQuery; + readonly query: PagedQuery; readonly replacementContinuationToken: string; /** * If useTotalResults is true, then totalResults represents an accurate count. @@ -539,33 +533,22 @@ export interface ISearchResultOfGroupBan { readonly useTotalResults: boolean; } -export interface IGroupBan { +export interface GroupBan { readonly groupId: string; - readonly lastModifiedBy: IUserInfoCard; - readonly createdBy: IUserInfoCard; + readonly lastModifiedBy: UserInfoCard; + readonly createdBy: UserInfoCard; readonly dateBanned: string; readonly dateExpires: string; readonly comment: string; - readonly bungieNetUserInfo: IUserInfoCard; - readonly destinyUserInfo: IUserInfoCard; -} - -export interface IGroupApplicationResponse { - readonly resolution: GroupApplicationResolveState; -} - -export const enum GroupApplicationResolveState { - Unresolved = 0, - Accepted = 1, - Denied = 2, - Rescinded = 3 + readonly bungieNetUserInfo: UserInfoCard; + readonly destinyUserInfo: UserInfoCard; } -export interface ISearchResultOfGroupMemberApplication { - readonly results: IGroupMemberApplication[]; +export interface SearchResultOfGroupMemberApplication { + readonly results: GroupMemberApplication[]; readonly totalResults: number; readonly hasMore: boolean; - readonly query: IPagedQuery; + readonly query: PagedQuery; readonly replacementContinuationToken: string; /** * If useTotalResults is true, then totalResults represents an accurate count. @@ -582,7 +565,7 @@ export interface ISearchResultOfGroupMemberApplication { readonly useTotalResults: boolean; } -export interface IGroupMemberApplication { +export interface GroupMemberApplication { readonly groupId: string; readonly creationDate: string; readonly resolveState: GroupApplicationResolveState; @@ -590,20 +573,27 @@ export interface IGroupMemberApplication { readonly resolvedByMembershipId?: string; readonly requestMessage: string; readonly resolveMessage: string; - readonly destinyUserInfo: IUserInfoCard; - readonly bungieNetUserInfo: IUserInfoCard; + readonly destinyUserInfo: UserInfoCard; + readonly bungieNetUserInfo: UserInfoCard; } -export interface IEntityActionResult { +export const enum GroupApplicationResolveState { + Unresolved = 0, + Accepted = 1, + Denied = 2, + Rescinded = 3 +} + +export interface EntityActionResult { readonly entityId: string; readonly result: PlatformErrorCodes; } -export interface IGroupMembershipSearchResponse { - readonly results: IGroupMembership[]; +export interface GroupMembershipSearchResponse { + readonly results: GroupMembership[]; readonly totalResults: number; readonly hasMore: boolean; - readonly query: IPagedQuery; + readonly query: PagedQuery; readonly replacementContinuationToken: string; /** * If useTotalResults is true, then totalResults represents an accurate count. @@ -620,16 +610,16 @@ export interface IGroupMembershipSearchResponse { readonly useTotalResults: boolean; } -export interface IGroupMembership { - readonly member: IGroupMember; - readonly group: IGroupV2; +export interface GroupMembership { + readonly member: GroupMember; + readonly group: GroupV2; } -export interface IGroupPotentialMembershipSearchResponse { - readonly results: IGroupPotentialMembership[]; +export interface GroupPotentialMembershipSearchResponse { + readonly results: GroupPotentialMembership[]; readonly totalResults: number; readonly hasMore: boolean; - readonly query: IPagedQuery; + readonly query: PagedQuery; readonly replacementContinuationToken: string; /** * If useTotalResults is true, then totalResults represents an accurate count. @@ -646,7 +636,11 @@ export interface IGroupPotentialMembershipSearchResponse { readonly useTotalResults: boolean; } -export interface IGroupPotentialMembership { - readonly member: IGroupPotentialMember; - readonly group: IGroupV2; +export interface GroupPotentialMembership { + readonly member: GroupPotentialMember; + readonly group: GroupV2; +} + +export interface GroupApplicationResponse { + readonly resolution: GroupApplicationResolveState; } diff --git a/src/type-definitions/index.ts b/src/type-definitions/index.ts index 269b5b7..929e47e 100644 --- a/src/type-definitions/index.ts +++ b/src/type-definitions/index.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. diff --git a/src/type-definitions/platform.ts b/src/type-definitions/platform.ts index b886990..ae537fe 100644 --- a/src/type-definitions/platform.ts +++ b/src/type-definitions/platform.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. @@ -10,11 +10,19 @@ * Do not edit these files manually. */ -export interface IIgnoreResponse { +export interface IgnoreResponse { readonly isIgnored: boolean; + /** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ readonly ignoreFlags: IgnoreStatus; } +/** + * This enum represents a set of flags - use bitwise operators to check which of + * these match your value. + */ export const enum IgnoreStatus { NotIgnored = 0, IgnoredUser = 1, @@ -25,12 +33,17 @@ export const enum IgnoreStatus { IgnoredGlobal = 32 } +/** + * Representing external partners to which BNet users can link accounts, but that + * are not Account System credentials: partnerships that BNet uses exclusively for + * data. + */ export const enum PartnershipType { None = 0, Twitch = 1 } -export interface ITagResponse { +export interface TagResponse { readonly tagText: string; - readonly ignoreStatus: IIgnoreResponse; + readonly ignoreStatus: IgnoreResponse; } diff --git a/src/type-definitions/trending/index.ts b/src/type-definitions/trending/index.ts index ce8fa5a..30180d1 100644 --- a/src/type-definitions/trending/index.ts +++ b/src/type-definitions/trending/index.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. diff --git a/src/type-definitions/trending/interfaces.ts b/src/type-definitions/trending/interfaces.ts index 6060950..c607324 100644 --- a/src/type-definitions/trending/interfaces.ts +++ b/src/type-definitions/trending/interfaces.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. @@ -11,20 +11,21 @@ */ import { - IContentItemPublicContract + ContentItemPublicContract } from '../content/interfaces'; import { - IDestinyMilestoneContent, - IDestinyPublicActivityStatus, - IDestinyPublicMilestone + DestinyMilestoneContent, + DestinyPublicActivityStatus, + DestinyPublicMilestone } from '../destiny2/interfaces'; import { - IPagedQuery + PagedQuery } from '../common'; import { PartnershipType } from '../platform'; +/** The known entity types that you can have returned from Trending. */ export const enum TrendingEntryType { News = 0, DestinyItem = 1, @@ -40,21 +41,21 @@ export const enum TrendingEntryType { Release = 11 } -export interface ITrendingCategories { - readonly categories: ITrendingCategory[]; +export interface TrendingCategories { + readonly categories: TrendingCategory[]; } -export interface ITrendingCategory { +export interface TrendingCategory { readonly categoryName: string; - readonly entries: ISearchResultOfTrendingEntry; + readonly entries: SearchResultOfTrendingEntry; readonly categoryId: string; } -export interface ISearchResultOfTrendingEntry { - readonly results: ITrendingEntry[]; +export interface SearchResultOfTrendingEntry { + readonly results: TrendingEntry[]; readonly totalResults: number; readonly hasMore: boolean; - readonly query: IPagedQuery; + readonly query: PagedQuery; readonly replacementContinuationToken: string; /** * If useTotalResults is true, then totalResults represents an accurate count. @@ -75,7 +76,7 @@ export interface ISearchResultOfTrendingEntry { * The list entry view for trending items. Returns just enough to show the item on * the trending page. */ -export interface ITrendingEntry { +export interface TrendingEntry { /** The weighted score of this trending item. */ readonly weight: number; readonly isFeatured: boolean; @@ -127,41 +128,41 @@ export interface ITrendingEntry { * also Trending Entries - contained within it. This is the ordered list of those * to display under the Container's header. */ - readonly items: ITrendingEntry[]; + readonly items: TrendingEntry[]; /** If the entry has a date at which it was created, this is that date. */ readonly creationDate?: string; } -export interface ITrendingDetail { +export interface TrendingDetail { readonly identifier: string; readonly entityType: TrendingEntryType; - readonly news: ITrendingEntryNews; - readonly support: ITrendingEntrySupportArticle; - readonly destinyItem: ITrendingEntryDestinyItem; - readonly destinyActivity: ITrendingEntryDestinyActivity; - readonly destinyRitual: ITrendingEntryDestinyRitual; - readonly creation: ITrendingEntryCommunityCreation; - readonly stream: ITrendingEntryCommunityStream; + readonly news: TrendingEntryNews; + readonly support: TrendingEntrySupportArticle; + readonly destinyItem: TrendingEntryDestinyItem; + readonly destinyActivity: TrendingEntryDestinyActivity; + readonly destinyRitual: TrendingEntryDestinyRitual; + readonly creation: TrendingEntryCommunityCreation; + readonly stream: TrendingEntryCommunityStream; } -export interface ITrendingEntryNews { - readonly article: IContentItemPublicContract; +export interface TrendingEntryNews { + readonly article: ContentItemPublicContract; } -export interface ITrendingEntrySupportArticle { - readonly article: IContentItemPublicContract; +export interface TrendingEntrySupportArticle { + readonly article: ContentItemPublicContract; } -export interface ITrendingEntryDestinyItem { +export interface TrendingEntryDestinyItem { readonly itemHash: number; } -export interface ITrendingEntryDestinyActivity { +export interface TrendingEntryDestinyActivity { readonly activityHash: number; - readonly status: IDestinyPublicActivityStatus; + readonly status: DestinyPublicActivityStatus; } -export interface ITrendingEntryDestinyRitual { +export interface TrendingEntryDestinyRitual { readonly image: string; readonly icon: string; readonly title: string; @@ -172,15 +173,15 @@ export interface ITrendingEntryDestinyRitual { * A destiny event does not necessarily have a related Milestone, but if it does * the details will be returned here. */ - readonly milestoneDetails: IDestinyPublicMilestone; + readonly milestoneDetails: DestinyPublicMilestone; /** * A destiny event will not necessarily have milestone "custom content", but if it * does the details will be here. */ - readonly eventContent: IDestinyMilestoneContent; + readonly eventContent: DestinyMilestoneContent; } -export interface ITrendingEntryCommunityCreation { +export interface TrendingEntryCommunityCreation { readonly media: string; readonly title: string; readonly author: string; @@ -190,7 +191,7 @@ export interface ITrendingEntryCommunityCreation { readonly upvotes: number; } -export interface ITrendingEntryCommunityStream { +export interface TrendingEntryCommunityStream { readonly image: string; readonly title: string; readonly partnershipIdentifier: string; diff --git a/src/type-definitions/user/index.ts b/src/type-definitions/user/index.ts index ce8fa5a..30180d1 100644 --- a/src/type-definitions/user/index.ts +++ b/src/type-definitions/user/index.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. diff --git a/src/type-definitions/user/interfaces.ts b/src/type-definitions/user/interfaces.ts index 922ee57..324bf29 100644 --- a/src/type-definitions/user/interfaces.ts +++ b/src/type-definitions/user/interfaces.ts @@ -2,7 +2,7 @@ * Bungie.Net API * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality. * - * OpenAPI spec version: 2.3.3 + * OpenAPI spec version: 2.3.5 * Contact: support@bungie.com * * NOTE: This class is auto generated by the bungie-api-ts code generator program. @@ -14,7 +14,7 @@ import { BungieMembershipType } from '../common'; import { - IIgnoreResponse, + IgnoreResponse, PartnershipType } from '../platform'; @@ -26,7 +26,7 @@ import { * details here. In cases where UserInfoCard is a subset of the data needed in a * contract, use UserInfoCard as a property of other contracts. */ -export interface IUserInfoCard { +export interface UserInfoCard { /** * A platform specific additional display name - ex: psn Real Name, bnet Unique * Name, etc. @@ -45,7 +45,7 @@ export interface IUserInfoCard { readonly displayName: string; } -export interface IGeneralUser { +export interface GeneralUser { readonly membershipId: string; readonly uniqueName: string; readonly normalizedName: string; @@ -59,7 +59,7 @@ export interface IGeneralUser { readonly firstAccess?: string; readonly lastUpdate?: string; readonly legacyPortalUID?: string; - readonly context: IUserToUserContext; + readonly context: UserToUserContext; readonly psnDisplayName: string; readonly xboxDisplayName: string; readonly fbDisplayName: string; @@ -78,29 +78,29 @@ export interface IGeneralUser { readonly blizzardDisplayName: string; } -export interface IUserToUserContext { +export interface UserToUserContext { readonly isFollowing: boolean; - readonly ignoreStatus: IIgnoreResponse; + readonly ignoreStatus: IgnoreResponse; readonly globalIgnoreEndDate?: string; } -export interface IUserTheme { +export interface UserTheme { readonly userThemeId: number; readonly userThemeName: string; readonly userThemeDescription: string; } -export interface IUserMembershipData { +export interface UserMembershipData { /** * this allows you to see destiny memberships that are visible and linked to this * account (regardless of whether or not they have characters on the world server) */ - readonly destinyMemberships: IUserInfoCard[]; - readonly bungieNetUser: IGeneralUser; + readonly destinyMemberships: UserInfoCard[]; + readonly bungieNetUser: GeneralUser; } /** All the partnership info that's fit to expose externally, if we care to do so. */ -export interface IPublicPartnershipDetail { +export interface PublicPartnershipDetail { readonly partnerType: PartnershipType; readonly identifier: string; readonly name: string; @@ -108,7 +108,7 @@ export interface IPublicPartnershipDetail { } /** Very basic info about a user as returned by the Account server. */ -export interface IUserMembership { +export interface UserMembership { /** Type of the membership. */ readonly membershipType: BungieMembershipType; /** Membership ID as they user is known in the Accounts service */ diff --git a/src/util.ts b/src/util.ts index 4384d15..9af5c9d 100644 --- a/src/util.ts +++ b/src/util.ts @@ -1,5 +1,5 @@ -import { IQueryStringParameters } from './type-definitions/additions'; -import { OAuthError } from './type-definitions/errors'; +import { QueryStringParameters } from './type-definitions/additions'; +import { OAuthError } from './errors'; /** * Generates the query string parameters out of the specified object which contains the parameters @@ -8,9 +8,7 @@ import { OAuthError } from './type-definitions/errors'; * @param {IQueryStringParameters} queryStringParameters Object which contains the query keys and values * @returns {string} The query string to add to the endpoint url */ -export function resolveQueryStringParameters( - queryStringParameters: IQueryStringParameters -): string { +export function resolveQueryStringParameters(queryStringParameters: QueryStringParameters): string { let queryString = '?'; const end = Object.keys(queryStringParameters).length; let count = 0; diff --git a/test/traveler.test.ts b/test/traveler.test.ts index ff3113f..76e995f 100644 --- a/test/traveler.test.ts +++ b/test/traveler.test.ts @@ -6,7 +6,7 @@ import Traveler from '../src/Traveler'; import { TypeDefinition } from '../src/type-definitions/additions'; import { BungieMembershipType } from '../src/type-definitions/app'; import { DestinyComponentType, PlatformErrorCodes, DestinyStatsGroupType } from '../src/type-definitions/destiny2'; -import { OAuthError } from '../src/type-definitions/errors'; +import { OAuthError } from '../src/errors'; dotenv.config(); @@ -199,6 +199,13 @@ describe('traveler.destiny2#getItem', () => { // TODO: getVendor (not yet final) +describe('traveler.destiny2#getPublicVendors', () => { + test('Respond with matching vendors', async () => { + const result = await traveler.destiny2.getPublicVendors({ components: [DestinyComponentType.Vendors] }); + expect(result.Response.vendorGroups).toBeDefined(); + }); +}); + // TODO: getPostGameCarnageReport describe('traveler.destiny2#getHistoricalStatsDefinition', () => {