This repository was archived by the owner on Dec 9, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathindex.html
More file actions
105 lines (94 loc) · 14.2 KB
/
index.html
File metadata and controls
105 lines (94 loc) · 14.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Wayward Types Viewer | 2.13.5-beta</title><meta name="description" content="Documentation for Wayward Types Viewer"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
<div class="tsd-toolbar-contents container">
<div class="table-cell" id="tsd-search" data-base=".">
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
<div class="field">
<div id="tsd-toolbar-links"></div></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">Wayward Types Viewer | 2.13.5-beta</a></div>
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
<div class="container container-main">
<div class="col-8 col-content">
<div class="tsd-page-title">
<h2>Wayward Types Viewer</h2></div>
<div class="tsd-panel tsd-typography"><p>This website documents the "types" of Wayward — basically, the structure of the game's code.</p>
<a href="#finding-an-export" id="finding-an-export" style="color: inherit; text-decoration: none;">
<h2>Finding an export</h2>
</a>
<p>Sometimes, while modding, you'll see examples which reference something you don't have, such as <code>ItemType</code>,
and VSCode will put a red underline under it because you haven't imported it yet. In cases where VSCode is unable to automatically
import it for you, you can find the path in this documentation.</p>
<p>Clicking on the magnifying glass icon at the top allows you to search the documentation for the export you're looking for.
In the case of <code>ItemType</code>, one of the suggestions is <code>game/item/IItem.ItemType</code>. Clicking on it goes to the definition.</p>
<p>Your import will be <code>import { NAME } from "PATH";</code>, where NAME is the export you were looking for (ie <code>ItemType</code>),
and PATH is the text of the <em>second</em> link in the breadcrumbs (ie at the top it might say, for example, <strong>Wayward Types Viewer</strong> / <strong>game/item/IItem</strong> / <strong>ItemType</strong> /).
For example <code>import { ItemType } from "game/item/IItem";</code>.</p>
<p>Some imports will be the "default" export from a module. In that case the import will be, for example, <code>import Register from "mod/ModRegistry";</code>
Notice how the import is the name without the <code>{}</code> curly braces.</p>
<a href="#other-tips-to-using-this-site" id="other-tips-to-using-this-site" style="color: inherit; text-decoration: none;">
<h2>Other tips to using this site</h2>
</a>
<p>The <a href="./modules.html">Module Index</a> contains a list of every single file in the game, and therefore all possible paths for you to import from.</p>
<p>The <strong>Common Modules</strong> section of the sidebar lists some commonly-referenced things for Wayward modding. Take a look!</p>
<p>You can visit <a href="https://waywardgame.github.io/development/">https://waywardgame.github.io/development/</a> to see a copy of the types specific for the "development" branch in the Steam betas.</p>
<a href="#need-help" id="need-help" style="color: inherit; text-decoration: none;">
<h1>Need help?</h1>
</a>
<a href="#wayward-modding-guide" id="wayward-modding-guide" style="color: inherit; text-decoration: none;">
<h1><a href="https://github.com/WaywardGame/types/wiki">Wayward Modding Guide</a></h1>
</a>
<p>Learn how to mod Wayward.</p>
<a href="#➡-new-modders-start-here-⬅" id="➡-new-modders-start-here-⬅" style="color: inherit; text-decoration: none;">
<h2><strong><a href="https://github.com/WaywardGame/types/wiki">➡ New Modders Start Here! ⬅</a></strong></h2>
</a>
<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
<h2>Documentation</h2>
</a>
<ul>
<li><a href="https://github.com/WaywardGame/types/wiki/mod-create-&-update"><code>+mod create</code> & <code>+mod update</code></a> — Documentation on the commands used to generate starter files for modding, and updating script mods.</li>
<li><a href="https://github.com/WaywardGame/types/wiki/mod.json"><code>mod.json</code></a> — Documentation on what all can be declared in the main mod metadata file.</li>
<li><a href="https://github.com/WaywardGame/types/wiki/Extracting-Wayward-Assets">Extracting assets</a> — A guide on extracting textures, sounds, and more from Wayward.</li>
</ul>
<a href="#mod-content" id="mod-content" style="color: inherit; text-decoration: none;">
<h2>Mod Content</h2>
</a>
<ul>
<li><a href="https://github.com/WaywardGame/types/wiki/Script-Mods">Scripts</a> — Create mods that change the functionality of the game, or add new content</li>
<li><a href="https://github.com/WaywardGame/types/wiki/Languages-&-Extensions">Languages & Extensions</a> — Adding new languages to Wayward, or adding translatable strings to mods.</li>
<li><a href="https://github.com/WaywardGame/types/wiki/Customizations">Customizations</a> — Adding new hair styles, hair colours, and skin tones</li>
<li><a href="https://github.com/WaywardGame/types/wiki/Image-Overrides">Image Overrides</a> — Replacing default sprites & textures</li>
<li><a href="https://github.com/WaywardGame/types/wiki/Stylesheets">Stylesheets</a> — Changing the appearance of the UI</li>
</ul>
<a href="#other-useful-links" id="other-useful-links" style="color: inherit; text-decoration: none;">
<h1>Other Useful Links</h1>
</a>
<a href="#wayward-types-viewer" id="wayward-types-viewer" style="color: inherit; text-decoration: none;">
<h2><a href="https://waywardgame.github.io/">Wayward Types Viewer</a></h2>
</a>
<p>A pretty, searchable list of all the type definitions in Wayward. For the raw form of these type definitions, see the <a href="https://github.com/WaywardGame/types"><code>types</code> repository on GitHub</a>.</p>
<a href="#modding-examples" id="modding-examples" style="color: inherit; text-decoration: none;">
<h2><a href="https://github.com/WaywardGame">Modding Examples</a></h2>
</a>
<p>Every official mod created for Wayward, and some other Wayward-related projects.</p>
<a href="#steam-workshop" id="steam-workshop" style="color: inherit; text-decoration: none;">
<h2><a href="http://steamcommunity.com/app/379210/workshop/">Steam Workshop</a></h2>
</a>
<p>Where Wayward mods are published.</p>
</div></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
<div class="tsd-accordion-details">
<div class="tsd-filter-visibility">
<h4 class="uppercase">Member Visibility</h4><form>
<ul id="tsd-filter-options">
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div>
<div class="tsd-theme-toggle">
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
<nav class="tsd-navigation primary"><h3 style="padding-bottom:10px;margin-bottom:0;">Navigation</h3><ul style="padding-bottom:10px"><li style="border:none"><a href="https://github.com/WaywardGame/types/wiki" style="padding-top:3px;padding-bottom:3px">Modding Guide</a></li><li style="border:none"><a href="modules.html" style="padding-top:3px;padding-bottom:3px">Module Index</a></li><li style="margin-top:7px"><h4 style="padding-bottom:10px;margin-bottom:0;">Common Modules</h4><ul><li class="tsd-kind-module" style="border:none"><a href="modules\mod_ModRegistry.default.html" class="tsd-index-link"style="padding-top:3px;padding-bottom:3px;margin-left:0"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4-path"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)" id="icon-4-text"></path></svg><span>@Register</span></a></li><li class="tsd-kind-interface" style="border:none"><a href="interfaces\game_doodad_IDoodad.IDoodadDescription.html" class="tsd-index-link"style="padding-top:3px;padding-bottom:3px;margin-left:0"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>IDoodadDescription</span></a></li><li class="tsd-kind-interface" style="border:none"><a href="interfaces\game_item_IItem.IItemDescription.html" class="tsd-index-link"style="padding-top:3px;padding-bottom:3px;margin-left:0"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>IItemDescription</span></a></li><li class="tsd-kind-interface" style="border:none"><a href="interfaces\game_tile_ITerrain.ITerrainDescription.html" class="tsd-index-link"style="padding-top:3px;padding-bottom:3px;margin-left:0"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>ITerrainDescription</span></a></li><li class="tsd-kind-interface" style="border:none"><a href="interfaces\game_tile_ITileEvent.ITileEventDescription.html" class="tsd-index-link"style="padding-top:3px;padding-bottom:3px;margin-left:0"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>ITileEventDescription</span></a></li><li class="tsd-kind-interface" style="border:none"><a href="interfaces\game_entity_creature_ICreature.ICreatureDescription.html" class="tsd-index-link"style="padding-top:3px;padding-bottom:3px;margin-left:0"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>ICreatureDescription</span></a></li></ul></li></ul></nav></div></div>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
<div class="overlay"></div><script src="assets/main.js"></script></body></html>