forked from Cammin/LDtkToUnity
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathLDtkUnity.html
More file actions
220 lines (206 loc) · 10.2 KB
/
LDtkUnity.html
File metadata and controls
220 lines (206 loc) · 10.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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Namespace LDtkUnity
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace LDtkUnity
">
<meta name="generator" content="docfx 2.56.7.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/img_logo_white.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<ol class="navbar-icons-list">
<li><a class="navbar-logo-link" href="https://github.com/Cammin/LDtkUnity"><img src="../images/github.svg"></a></li>
</ol>
</div>
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="LDtkUnity">
<h1 id="LDtkUnity" data-uid="LDtkUnity" class="text-break">Namespace LDtkUnity
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="LDtkUnity.Definitions.html">Definitions</a></h4>
<section><p>Json Definition Data</p>
</section>
<h4><a class="xref" href="LDtkUnity.EntityDefinition.html">EntityDefinition</a></h4>
<section><p>Json Definition Data</p>
</section>
<h4><a class="xref" href="LDtkUnity.EntityInstance.html">EntityInstance</a></h4>
<section><p>Json Instance Data</p>
</section>
<h4><a class="xref" href="LDtkUnity.EntityInstanceTile.html">EntityInstanceTile</a></h4>
<section><p>Json Instance Data</p>
</section>
<h4><a class="xref" href="LDtkUnity.EnumDefinition.html">EnumDefinition</a></h4>
<section><p>Json Definition Data</p>
</section>
<h4><a class="xref" href="LDtkUnity.EnumValueDefinition.html">EnumValueDefinition</a></h4>
<section><p>Json Definition Data</p>
</section>
<h4><a class="xref" href="LDtkUnity.FieldInstance.html">FieldInstance</a></h4>
<section><p>Json Instance Data</p>
</section>
<h4><a class="xref" href="LDtkUnity.IntGridValueDefinition.html">IntGridValueDefinition</a></h4>
<section><p>Json Definition Data</p>
</section>
<h4><a class="xref" href="LDtkUnity.LayerDefinition.html">LayerDefinition</a></h4>
<section><p>Json Definition Data</p>
</section>
<h4><a class="xref" href="LDtkUnity.LayerInstance.html">LayerInstance</a></h4>
<section><p>Json Instance Data</p>
</section>
<h4><a class="xref" href="LDtkUnity.LDtkArtifactAssets.html">LDtkArtifactAssets</a></h4>
<section><p>Stores the autogenerated sprites for the tiles, sprites for level backgrounds, and all TileBases for the Int Grid values, and for the LDtk tiles.</p>
</section>
<h4><a class="xref" href="LDtkUnity.LDtkComponentLevel.html">LDtkComponentLevel</a></h4>
<section><p>This component can be used to get certain LDtk information of a level. Accessible from level GameObjects.</p>
</section>
<h4><a class="xref" href="LDtkUnity.LDtkComponentProject.html">LDtkComponentProject</a></h4>
<section><p>A component available in the the import result's root GameObject. Reference this to access the json data.</p>
</section>
<h4><a class="xref" href="LDtkUnity.LDtkFields.html">LDtkFields</a></h4>
<section><p>This is a component that stores the field instances for entities/levels, Conveniently converted for use in Unity.</p>
</section>
<h4><a class="xref" href="LDtkUnity.LDtkIntGridTile.html">LDtkIntGridTile</a></h4>
<section><p>The tile used for IntGridValues in LDtk. Not AutoLayers and Tile layers.<br>
Inherit from this for more custom functionality if required.</p>
</section>
<h4><a class="xref" href="LDtkUnity.LdtkJson.html">LdtkJson</a></h4>
<section><p>Json Root</p>
</section>
<h4><a class="xref" href="LDtkUnity.LDtkKeyFormatUtil.html">LDtkKeyFormatUtil</a></h4>
<section><p>A utility class used in conjunction with <a class="xref" href="LDtkUnity.LDtkArtifactAssets.html">LDtkArtifactAssets</a> to get certain assets by name.</p>
</section>
<h4><a class="xref" href="LDtkUnity.LDtkLevelFile.html">LDtkLevelFile</a></h4>
<section><p>The imported level file. (.ldtkl)<br>
Available when saving levels as separate files in LDtk. Reference this to access the json data.</p>
</section>
<h4><a class="xref" href="LDtkUnity.LDtkProjectFile.html">LDtkProjectFile</a></h4>
<section><p>The imported level file, available in the the import result. Reference this to access the json data.</p>
</section>
<h4><a class="xref" href="LDtkUnity.LDtkUidBank.html">LDtkUidBank</a></h4>
<section><p>Responsible for holding onto LDtk definitions so that they are easily accessible by instance classes.</p>
</section>
<h4><a class="xref" href="LDtkUnity.Level.html">Level</a></h4>
<section><p>Json Level Data</p>
</section>
<h4><a class="xref" href="LDtkUnity.LevelBackgroundPosition.html">LevelBackgroundPosition</a></h4>
<section><p>Json Level Data</p>
</section>
<h4><a class="xref" href="LDtkUnity.NeighbourLevel.html">NeighbourLevel</a></h4>
<section><p>Json Level Data</p>
</section>
<h4><a class="xref" href="LDtkUnity.TileInstance.html">TileInstance</a></h4>
<section><p>Json Instance Data</p>
</section>
<h4><a class="xref" href="LDtkUnity.TilesetDefinition.html">TilesetDefinition</a></h4>
<section><p>Json Definition Data</p>
</section>
<h3 id="interfaces">Interfaces
</h3>
<h4><a class="xref" href="LDtkUnity.ILDtkImportedEntity.html">ILDtkImportedEntity</a></h4>
<section><p>Applicable for entity prefabs only. <br>
Use this interface on a entity's prefab components to access the entity instance's data during the import process.</p>
</section>
<h4><a class="xref" href="LDtkUnity.ILDtkImportedFields.html">ILDtkImportedFields</a></h4>
<section><p>Applicable for both entity prefabs and the level prefab. <br>
Use this interface on entity/level components to access the field instances of the entity/level.</p>
</section>
<h4><a class="xref" href="LDtkUnity.ILDtkImportedLayer.html">ILDtkImportedLayer</a></h4>
<section><p>Applicable for entity prefabs only. <br>
Use this interface on an entity's prefab components to access the layer of this entity instance during the import process.</p>
</section>
<h4><a class="xref" href="LDtkUnity.ILDtkImportedLevel.html">ILDtkImportedLevel</a></h4>
<section><p>Applicable for the level prefab only. <br>
Use this interface on a level's prefab components to access the level's data during the import process.</p>
</section>
<h4><a class="xref" href="LDtkUnity.ILDtkImportedSortingOrder.html">ILDtkImportedSortingOrder</a></h4>
<section><p>Applicable for entity prefabs only. <br>
This passes in an int that represents the sorting order to set. <br>
The sorting order value is automatically determined by the layer generation. <br>
Use this interface for setting a renderer's sorting order if applicable. ex. Renderer, SpriteRenderer, SortingGroup, etc.</p>
</section>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>