Skip to content

Commit

Permalink
deploy: e7a4c8a
Browse files Browse the repository at this point in the history
  • Loading branch information
@GalaxyCrush
GalaxyCrush committed Oct 17, 2024
1 parent 89b463f commit 927643c
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 9 deletions.
65 changes: 57 additions & 8 deletions classcubos_1_1engine_1_1AnyAsset.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ <h3>Contents</h3>
Reference
<ul>
<li><a href="#derived-classes">Derived classes</a></li>
<li><a href="#pub-types">Public types</a></li>
<li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
<li><a href="#pub-methods">Public functions</a></li>
<li><a href="#pub-attribs">Public variables</a></li>
Expand Down Expand Up @@ -91,6 +92,17 @@ <h2><a href="#derived-classes">Derived classes</a></h2>
<dd>Handle to an asset of a specific type.</dd>
</dl>
</section>
<section id="pub-types">
<h2><a href="#pub-types">Public types</a></h2>
<dl class="m-doc">
<dt id="a5a2888e2033939d6602e378278a6ea12">
<span class="m-doc-wrap-bumper">enum class <a href="#a5a2888e2033939d6602e378278a6ea12" class="m-doc-self">IdType</a> { </span><span class="m-doc-wrap"><a href="#a5a2888e2033939d6602e378278a6ea12a5a54d9ad87f7c4c1c70c8f05b9515d5a" class="m-doc">UUID</a>,
<a href="#a5a2888e2033939d6602e378278a6ea12aac70412e939d72a9234cdebb1af5867b" class="m-doc">Path</a>,
<a href="#a5a2888e2033939d6602e378278a6ea12a4bbb8f967da6d1a610596d7257179c2b" class="m-doc">Invalid</a> }</span>
</dt>
<dd>Type of the asset identifier.</dd>
</dl>
</section>
<section id="typeless-methods">
<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
<dl class="m-doc">
Expand Down Expand Up @@ -141,9 +153,17 @@ <h2><a href="#pub-methods">Public functions</a></h2>
</dt>
<dd>Gets the version of the asset last seen by this handle.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#a71d67a1ee37c73927a94e1f2a88aee24" class="m-doc">getId</a>(</span><span class="m-doc-wrap">) const -&gt; uuids::uuid</span>
<span class="m-doc-wrap-bumper">auto <a href="#a78a8a0d60d7d0b756e6f2df56bee626a" class="m-doc">getIdType</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="classcubos_1_1engine_1_1AnyAsset.html#a5a2888e2033939d6602e378278a6ea12" class="m-doc">IdType</a></span>
</dt>
<dd>Gets the type of the asset identifier.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#a01bd252f49fc957785414d26af158714" class="m-doc">getIdString</a>(</span><span class="m-doc-wrap">) const -&gt; std::string</span>
</dt>
<dd>Gets the Path or UUID of the asset.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#a143d2628d7e5e2ef35ac3e8a8eb530bb" class="m-doc">getId</a>(</span><span class="m-doc-wrap">) const -&gt; std::optional&lt;uuids::uuid&gt;</span>
</dt>
<dd>Gets the UUID of the asset.</dd>
<dd>Gets the UUID of the asset if it has one.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#a71be11e482301a872a0d9f51478f4334" class="m-doc">isNull</a>(</span><span class="m-doc-wrap">) const -&gt; bool</span>
</dt>
Expand All @@ -161,10 +181,10 @@ <h2><a href="#pub-methods">Public functions</a></h2>
<section id="pub-attribs">
<h2><a href="#pub-attribs">Public variables</a></h2>
<dl class="m-doc">
<dt id="a54deb5d54d93771b55493890d40dc061">
uuids::uuid <a href="#a54deb5d54d93771b55493890d40dc061" class="m-doc-self">reflectedId</a>
<dt id="a8c7363d88f8024428b825d06ab399569">
std::string <a href="#a8c7363d88f8024428b825d06ab399569" class="m-doc-self">pathOrId</a>
</dt>
<dd>Avoid using this field, use <a href="classcubos_1_1engine_1_1AnyAsset.html#a71d67a1ee37c73927a94e1f2a88aee24" class="m-doc">getId()</a> instead.</dd>
<dd>Avoid using this field, use <a href="classcubos_1_1engine_1_1AnyAsset.html#a143d2628d7e5e2ef35ac3e8a8eb530bb" class="m-doc">getId()</a> instead.</dd>
</dl>
</section>
<section id="pro-static-methods">
Expand Down Expand Up @@ -343,11 +363,39 @@ <h3>
</tfoot>
</table>
</div></section>
<section class="m-doc-details" id="a71d67a1ee37c73927a94e1f2a88aee24"><div>
<section class="m-doc-details" id="a78a8a0d60d7d0b756e6f2df56bee626a"><div>
<h3>
<span class="m-doc-wrap-bumper"><a href="classcubos_1_1engine_1_1AnyAsset.html#a5a2888e2033939d6602e378278a6ea12" class="m-doc">IdType</a> cubos::<wbr />engine::<wbr />AnyAsset::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a78a8a0d60d7d0b756e6f2df56bee626a" class="m-doc-self">getIdType</a>(</span><span class="m-doc-wrap">) const</span></span>
</h3>
<p>Gets the type of the asset identifier.</p>
<table class="m-table m-fullwidth m-flat">
<tfoot>
<tr>
<th style="width: 1%">Returns</th>
<td><a href="classcubos_1_1engine_1_1Asset.html" class="m-doc">Asset</a> identifier type.</td>
</tr>
</tfoot>
</table>
</div></section>
<section class="m-doc-details" id="a01bd252f49fc957785414d26af158714"><div>
<h3>
<span class="m-doc-wrap-bumper">std::string cubos::<wbr />engine::<wbr />AnyAsset::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a01bd252f49fc957785414d26af158714" class="m-doc-self">getIdString</a>(</span><span class="m-doc-wrap">) const</span></span>
</h3>
<p>Gets the Path or UUID of the asset.</p>
<table class="m-table m-fullwidth m-flat">
<tfoot>
<tr>
<th style="width: 1%">Returns</th>
<td><a href="classcubos_1_1engine_1_1Asset.html" class="m-doc">Asset</a> Path or UUID.</td>
</tr>
</tfoot>
</table>
</div></section>
<section class="m-doc-details" id="a143d2628d7e5e2ef35ac3e8a8eb530bb"><div>
<h3>
<span class="m-doc-wrap-bumper">uuids::uuid cubos::<wbr />engine::<wbr />AnyAsset::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a71d67a1ee37c73927a94e1f2a88aee24" class="m-doc-self">getId</a>(</span><span class="m-doc-wrap">) const</span></span>
<span class="m-doc-wrap-bumper">std::optional&lt;uuids::uuid&gt; cubos::<wbr />engine::<wbr />AnyAsset::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a143d2628d7e5e2ef35ac3e8a8eb530bb" class="m-doc-self">getId</a>(</span><span class="m-doc-wrap">) const</span></span>
</h3>
<p>Gets the UUID of the asset.</p>
<p>Gets the UUID of the asset if it has one.</p>
<table class="m-table m-fullwidth m-flat">
<tfoot>
<tr>
Expand All @@ -356,6 +404,7 @@ <h3>
</tr>
</tfoot>
</table>
<p>There are two possible reasons for an asset handle to have no UUID:</p><ul><li>it being an invalid or null handle;</li><li>it being created from an asset path.</li></ul><p>To ensure an asset handle gets a UUID, you can use <a href="classcubos_1_1engine_1_1Assets.html#ae36fcf1fb1a44c37a404c3aab43a5c4b" class="m-doc">Assets::<wbr />load</a>.</p>
</div></section>
<section class="m-doc-details" id="a71be11e482301a872a0d9f51478f4334"><div>
<h3>
Expand Down
36 changes: 36 additions & 0 deletions classcubos_1_1engine_1_1AssetMeta.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,14 @@ <h2><a href="#pub-methods">Public functions</a></h2>
<span class="m-doc-wrap-bumper">auto <a href="#ae4785c72d8f5a4e15f176970393a1547" class="m-doc">get</a>(</span><span class="m-doc-wrap">std::string_view key) const -&gt; std::optional&lt;std::string&gt;</span>
</dt>
<dd>Gets the value of a parameter on the asset&#x27;s metadata.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#a60a8d959dc4438eee2f413e89bb98e1a" class="m-doc">getId</a>(</span><span class="m-doc-wrap">) const -&gt; uuids::uuid</span>
</dt>
<dd>Gets the ID of the asset.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#ac4661673e81d8e76f29a66bfba675b38" class="m-doc">getPath</a>(</span><span class="m-doc-wrap">) const -&gt; std::optional&lt;std::string&gt;</span>
</dt>
<dd>Gets the path of the asset.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#ae0e90a1648ca557020ec10acb4cfa307" class="m-doc">set</a>(</span><span class="m-doc-wrap">std::string_view key,
std::string_view value)</span>
Expand Down Expand Up @@ -123,6 +131,34 @@ <h3>
</tfoot>
</table>
</div></section>
<section class="m-doc-details" id="a60a8d959dc4438eee2f413e89bb98e1a"><div>
<h3>
<span class="m-doc-wrap-bumper">uuids::uuid cubos::<wbr />engine::<wbr />AssetMeta::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a60a8d959dc4438eee2f413e89bb98e1a" class="m-doc-self">getId</a>(</span><span class="m-doc-wrap">) const</span></span>
</h3>
<p>Gets the ID of the asset.</p>
<table class="m-table m-fullwidth m-flat">
<tfoot>
<tr>
<th style="width: 1%">Returns</th>
<td>ID of the asset.</td>
</tr>
</tfoot>
</table>
</div></section>
<section class="m-doc-details" id="ac4661673e81d8e76f29a66bfba675b38"><div>
<h3>
<span class="m-doc-wrap-bumper">std::optional&lt;std::string&gt; cubos::<wbr />engine::<wbr />AssetMeta::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ac4661673e81d8e76f29a66bfba675b38" class="m-doc-self">getPath</a>(</span><span class="m-doc-wrap">) const</span></span>
</h3>
<p>Gets the path of the asset.</p>
<table class="m-table m-fullwidth m-flat">
<tfoot>
<tr>
<th style="width: 1%">Returns</th>
<td>Path of the asset.</td>
</tr>
</tfoot>
</table>
</div></section>
<section class="m-doc-details" id="ae0e90a1648ca557020ec10acb4cfa307"><div>
<h3>
<span class="m-doc-wrap-bumper">void cubos::<wbr />engine::<wbr />AssetMeta::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ae0e90a1648ca557020ec10acb4cfa307" class="m-doc-self">set</a>(</span><span class="m-doc-wrap">std::string_view key,
Expand Down
2 changes: 1 addition & 1 deletion searchdata-v2.js
View file

Large diffs are not rendered by default.

0 comments on commit 927643c

Please sign in to comment.