UNPKG

node-csgo-parser

Version:

Extract Items/Skins/... from raw VDF data files

1,483 lines (425 loc) 19.8 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Global - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css"> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="global.html#Collection">Collection</a></li><li><a href="CSGODataParser.html">CSGODataParser</a><ul class='methods'><li data-type='method'><a href="CSGODataParser.html#getCaseKeys">getCaseKeys</a></li><li data-type='method'><a href="CSGODataParser.html#getCases">getCases</a></li><li data-type='method'><a href="CSGODataParser.html#getCollections">getCollections</a></li><li data-type='method'><a href="CSGODataParser.html#getExteriors">getExteriors</a></li><li data-type='method'><a href="CSGODataParser.html#getLangValue">getLangValue</a></li><li data-type='method'><a href="CSGODataParser.html#getLogger">getLogger</a></li><li data-type='method'><a href="CSGODataParser.html#getMusicKits">getMusicKits</a></li><li data-type='method'><a href="CSGODataParser.html#getRaritiesIndex">getRaritiesIndex</a></li><li data-type='method'><a href="CSGODataParser.html#getStickers">getStickers</a></li><li data-type='method'><a href="CSGODataParser.html#getWeapons">getWeapons</a></li><li data-type='method'><a href="CSGODataParser.html#isDatasInitialized">isDatasInitialized</a></li><li data-type='method'><a href="CSGODataParser.html#isLangInitialized">isLangInitialized</a></li></ul></li><li><a href="global.html#MusicKit">MusicKit</a></li><li><a href="global.html#Prefab">Prefab</a></li><li><a href="global.html#Rarity">Rarity</a></li><li><a href="global.html#SkinPaint">SkinPaint</a></li><li><a href="global.html#Sticker">Sticker</a></li><li><a href="global.html#Weapon">Weapon</a></li></ul><h3><a href="global.html">Global</a></h3> </nav> <div id="main"> <h1 class="page-title">Global</h1> <section> <header> <h2> </h2> </header> <article> <div class="container-overview"> <dl class="details"> </dl> </div> <h3 class="subsection-title">Type Definitions</h3> <h4 class="name" id="Collection">Collection</h4> <h5>Type:</h5> <ul> <li> <span class="param-type">Object</span> </li> </ul> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">I18N name of the collection</td> </tr> <tr> <td class="name"><code>techName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Technical name of the collection</td> </tr> <tr> <td class="name"><code>content</code></td> <td class="type"> <span class="param-type">Array.&lt;<a href="global.html#SkinPaint">SkinPaint</a>></span> </td> <td class="description last">skins List of skins for this Collection (Doe'nt contain knifes)</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Collection.js.html">Collection.js</a>, <a href="Collection.js.html#line4">line 4</a> </li></ul></dd> </dl> <h4 class="name" id="MusicKit">MusicKit</h4> <h5>Type:</h5> <ul> <li> <span class="param-type">Object</span> </li> </ul> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">I18N name of the music kit</td> </tr> <tr> <td class="name"><code>techName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Technical name of the music kit</td> </tr> <tr> <td class="name"><code>defIndex</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Index/Key of the music kit</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="MusicKit.js.html">MusicKit.js</a>, <a href="MusicKit.js.html#line4">line 4</a> </li></ul></dd> </dl> <h4 class="name" id="Prefab">Prefab</h4> <h5>Type:</h5> <ul> <li> <span class="param-type">Object</span> </li> </ul> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">I18N name of the prefab object</td> </tr> <tr> <td class="name"><code>techName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Technical name of the prefab object</td> </tr> <tr> <td class="name"><code>defIndex</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Index/Key of the prefab</td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Type of the prefab object</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Prefab.js.html">Prefab.js</a>, <a href="Prefab.js.html#line4">line 4</a> </li></ul></dd> </dl> <h4 class="name" id="Rarity">Rarity</h4> <h5>Type:</h5> <ul> <li> <span class="param-type">Object</span> </li> </ul> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>techName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Technical name of the rarity</td> </tr> <tr> <td class="name"><code>weaponName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">I18N name applied to a weapon</td> </tr> <tr> <td class="name"><code>miscName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">I18N name applied to others objects (Medal, Music, ...)</td> </tr> <tr> <td class="name"><code>defIndex</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">defIndex Index/Key of the Perfab Object</td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Hexadecimal color value that represent the quality</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Rarity.js.html">Rarity.js</a>, <a href="Rarity.js.html#line4">line 4</a> </li></ul></dd> </dl> <h4 class="name" id="SkinPaint">SkinPaint</h4> <h5>Type:</h5> <ul> <li> <span class="param-type">Object</span> </li> </ul> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">I18N name of the paint/skin</td> </tr> <tr> <td class="name"><code>techName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Technical name of the paint/skin</td> </tr> <tr> <td class="name"><code>weaponTechName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Technical name of the weapon</td> </tr> <tr> <td class="name"><code>fullName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">I18N Full name of the Skin (doesn't contain Statrak or (Quality) information. Beside, knifes got their little star :p)</td> </tr> <tr> <td class="name"><code>rarity</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Rarity of this paint (inexplicably, some of them are wrong on items file regarding in-game reality)</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="SkinPaint.js.html">SkinPaint.js</a>, <a href="SkinPaint.js.html#line4">line 4</a> </li></ul></dd> </dl> <h4 class="name" id="Sticker">Sticker</h4> <h5>Type:</h5> <ul> <li> <span class="param-type">Object</span> </li> </ul> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">I18N name of the sticker</td> </tr> <tr> <td class="name"><code>techName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Technical name of the sticker</td> </tr> <tr> <td class="name"><code>defIndex</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Index/Key of the sticker</td> </tr> <tr> <td class="name"><code>rarity</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Rarity of this sticker</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Sticker.js.html">Sticker.js</a>, <a href="Sticker.js.html#line4">line 4</a> </li></ul></dd> </dl> <h4 class="name" id="Weapon">Weapon</h4> <h5>Type:</h5> <ul> <li> <span class="param-type">Object</span> </li> </ul> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">I18N name of the weapon</td> </tr> <tr> <td class="name"><code>techName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Technical name of the weapon</td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Weapon category (Pistol, Rifle, SMG...)</td> </tr> <tr> <td class="name"><code>defIndex</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Technical index in CSGO Schema</td> </tr> <tr> <td class="name"><code>skins</code></td> <td class="type"> <span class="param-type">Array.&lt;<a href="global.html#SkinPaint">SkinPaint</a>></span> </td> <td class="description last">List of skins for this Weapon</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Weapon.js.html">Weapon.js</a>, <a href="Weapon.js.html#line4">line 4</a> </li></ul></dd> </dl> </article> </section> </div> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jan 14 2016 18:47:02 GMT+0100 (Paris, Madrid) using the Minami theme. </footer> <script>prettyPrint();</script> <script src="scripts/linenumber.js"></script> </body> </html>