<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>DestinyFactionDefinition | bungie-api-ts</title>
	<meta name="description" content="">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">bungie-api-ts</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-externals" checked />
							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
							<input type="checkbox" id="tsd-filter-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../globals.html">Globals</a>
				</li>
				<li>
					<a href="../modules/_destiny2_interfaces_.html">&quot;destiny2/interfaces&quot;</a>
				</li>
				<li>
					<a href="_destiny2_interfaces_.destinyfactiondefinition.html">DestinyFactionDefinition</a>
				</li>
			</ul>
			<h1>Interface DestinyFactionDefinition</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-comment">
				<div class="tsd-comment tsd-typography">
					<div class="lead">
						<p>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.</p>
					</div>
					<p>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.</p>
				</div>
			</section>
			<section class="tsd-panel tsd-hierarchy">
				<h3>Hierarchy</h3>
				<ul class="tsd-hierarchy">
					<li>
						<span class="target">DestinyFactionDefinition</span>
					</li>
				</ul>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Properties</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_destiny2_interfaces_.destinyfactiondefinition.html#displayproperties" class="tsd-kind-icon">display<wbr>Properties</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_destiny2_interfaces_.destinyfactiondefinition.html#hash" class="tsd-kind-icon">hash</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_destiny2_interfaces_.destinyfactiondefinition.html#index" class="tsd-kind-icon">index</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_destiny2_interfaces_.destinyfactiondefinition.html#progressionhash" class="tsd-kind-icon">progression<wbr>Hash</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_destiny2_interfaces_.destinyfactiondefinition.html#redacted" class="tsd-kind-icon">redacted</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_destiny2_interfaces_.destinyfactiondefinition.html#rewarditemhash" class="tsd-kind-icon">reward<wbr>Item<wbr>Hash</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_destiny2_interfaces_.destinyfactiondefinition.html#rewardvendorhash" class="tsd-kind-icon">reward<wbr>Vendor<wbr>Hash</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_destiny2_interfaces_.destinyfactiondefinition.html#tokenvalues" class="tsd-kind-icon">token<wbr>Values</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_destiny2_interfaces_.destinyfactiondefinition.html#vendors" class="tsd-kind-icon">vendors</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Properties</h2>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="displayproperties" class="tsd-anchor"></a>
					<h3>display<wbr>Properties</h3>
					<div class="tsd-signature tsd-kind-icon">display<wbr>Properties<span class="tsd-signature-symbol">:</span> <a href="_destiny2_interfaces_.destinydisplaypropertiesdefinition.html" class="tsd-signature-type">DestinyDisplayPropertiesDefinition</a></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/DigitalClouds/bungie-api-ts/blob/c8d1606/generated-src/destiny2/interfaces.ts#L1554">destiny2/interfaces.ts:1554</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="hash" class="tsd-anchor"></a>
					<h3>hash</h3>
					<div class="tsd-signature tsd-kind-icon">hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/DigitalClouds/bungie-api-ts/blob/c8d1606/generated-src/destiny2/interfaces.ts#L1588">destiny2/interfaces.ts:1588</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The unique identifier for this entity. Guaranteed to be unique for the type of
							entity, but not globally.</p>
						</div>
						<p>When entities refer to each other in Destiny content, it is this hash that they
						are referring to.</p>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="index" class="tsd-anchor"></a>
					<h3>index</h3>
					<div class="tsd-signature tsd-kind-icon">index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/DigitalClouds/bungie-api-ts/blob/c8d1606/generated-src/destiny2/interfaces.ts#L1590">destiny2/interfaces.ts:1590</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The index of the entity as it was found in the investment tables.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="progressionhash" class="tsd-anchor"></a>
					<h3>progression<wbr>Hash</h3>
					<div class="tsd-signature tsd-kind-icon">progression<wbr>Hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/DigitalClouds/bungie-api-ts/blob/c8d1606/generated-src/destiny2/interfaces.ts#L1561">destiny2/interfaces.ts:1561</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The hash identifier for the DestinyProgressionDefinition that indicates the
							character&#39;s relationship with this faction in terms of experience and levels.</p>
						</div>
						<p>Mapped to DestinyProgressionDefinition in the manifest.</p>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="redacted" class="tsd-anchor"></a>
					<h3>redacted</h3>
					<div class="tsd-signature tsd-kind-icon">redacted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/DigitalClouds/bungie-api-ts/blob/c8d1606/generated-src/destiny2/interfaces.ts#L1595">destiny2/interfaces.ts:1595</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>If this is true, then there is an entity with this identifier/type combination,
							but BNet is not yet allowed to show it. Sorry!</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="rewarditemhash" class="tsd-anchor"></a>
					<h3>reward<wbr>Item<wbr>Hash</h3>
					<div class="tsd-signature tsd-kind-icon">reward<wbr>Item<wbr>Hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/DigitalClouds/bungie-api-ts/blob/c8d1606/generated-src/destiny2/interfaces.ts#L1569">destiny2/interfaces.ts:1569</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The faction reward item hash, usually an engram.</p>
						</div>
						<p>Mapped to DestinyInventoryItemDefinition in the manifest.</p>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="rewardvendorhash" class="tsd-anchor"></a>
					<h3>reward<wbr>Vendor<wbr>Hash</h3>
					<div class="tsd-signature tsd-kind-icon">reward<wbr>Vendor<wbr>Hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/DigitalClouds/bungie-api-ts/blob/c8d1606/generated-src/destiny2/interfaces.ts#L1575">destiny2/interfaces.ts:1575</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The faction reward vendor hash, used for faction engram previews.</p>
						</div>
						<p>Mapped to DestinyVendorDefinition in the manifest.</p>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="tokenvalues" class="tsd-anchor"></a>
					<h3>token<wbr>Values</h3>
					<div class="tsd-signature tsd-kind-icon">token<wbr>Values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/DigitalClouds/bungie-api-ts/blob/c8d1606/generated-src/destiny2/interfaces.ts#L1563">destiny2/interfaces.ts:1563</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The faction token item hashes, and their respective progression values.</p>
						</div>
					</div>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter-index-signature">
								<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">number</span></h5>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="vendors" class="tsd-anchor"></a>
					<h3>vendors</h3>
					<div class="tsd-signature tsd-kind-icon">vendors<span class="tsd-signature-symbol">:</span> <a href="_destiny2_interfaces_.destinyfactionvendordefinition.html" class="tsd-signature-type">DestinyFactionVendorDefinition</a><span class="tsd-signature-symbol">[]</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/DigitalClouds/bungie-api-ts/blob/c8d1606/generated-src/destiny2/interfaces.ts#L1580">destiny2/interfaces.ts:1580</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>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.</p>
						</div>
					</div>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="../globals.html"><em>Globals</em></a>
					</li>
					<li class="current tsd-kind-external-module">
						<a href="../modules/_destiny2_interfaces_.html">"destiny2/interfaces"</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
				</ul>
				<ul class="current">
					<li class="current tsd-kind-interface tsd-parent-kind-external-module">
						<a href="_destiny2_interfaces_.destinyfactiondefinition.html" class="tsd-kind-icon">Destiny<wbr>Faction<wbr>Definition</a>
						<ul>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_destiny2_interfaces_.destinyfactiondefinition.html#displayproperties" class="tsd-kind-icon">display<wbr>Properties</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_destiny2_interfaces_.destinyfactiondefinition.html#hash" class="tsd-kind-icon">hash</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_destiny2_interfaces_.destinyfactiondefinition.html#index" class="tsd-kind-icon">index</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_destiny2_interfaces_.destinyfactiondefinition.html#progressionhash" class="tsd-kind-icon">progression<wbr>Hash</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_destiny2_interfaces_.destinyfactiondefinition.html#redacted" class="tsd-kind-icon">redacted</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_destiny2_interfaces_.destinyfactiondefinition.html#rewarditemhash" class="tsd-kind-icon">reward<wbr>Item<wbr>Hash</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_destiny2_interfaces_.destinyfactiondefinition.html#rewardvendorhash" class="tsd-kind-icon">reward<wbr>Vendor<wbr>Hash</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_destiny2_interfaces_.destinyfactiondefinition.html#tokenvalues" class="tsd-kind-icon">token<wbr>Values</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_destiny2_interfaces_.destinyfactiondefinition.html#vendors" class="tsd-kind-icon">vendors</a>
							</li>
						</ul>
					</li>
				</ul>
				<ul class="after-current">
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>
{'avg_line_length': 54.28238341968912, 'max_line_length': 276, 'alphanum_fraction': 0.6753209564262874, 'licenses': ['MIT', 'BSD-3-Clause'], 'repository_name': 'DigitalClouds/bungie-api-ts', 'path': 'docs/interfaces/_destiny2_interfaces_.destinyfactiondefinition.html', 'size': 20953, 'lang': 'HTML'}