Skip to content

Commit

Permalink
Update documentation for main
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 10, 2025
1 parent 4beff18 commit f812d78
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions main/azalea_core/game_type/enum.GameMode.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
Spectator,
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A Minecraft gamemode, like survival or creative.</p>
</div></details><h2 id="variants" class="variants section-header">Variants<a href="#variants" class="anchor">§</a></h2><div class="variants"><section id="variant.Survival" class="variant"><a href="#variant.Survival" class="anchor">§</a><h3 class="code-header">Survival</h3></section><section id="variant.Creative" class="variant"><a href="#variant.Creative" class="anchor">§</a><h3 class="code-header">Creative</h3></section><section id="variant.Adventure" class="variant"><a href="#variant.Adventure" class="anchor">§</a><h3 class="code-header">Adventure</h3></section><section id="variant.Spectator" class="variant"><a href="#variant.Spectator" class="anchor">§</a><h3 class="code-header">Spectator</h3></section></div><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-GameMode" class="impl"><a class="src rightside" href="../../src/azalea_core/game_type.rs.html#17-85">Source</a><a href="#impl-GameMode" class="anchor">§</a><h3 class="code-header">impl <a class="enum" href="enum.GameMode.html" title="enum azalea_core::game_type::GameMode">GameMode</a></h3></section></summary><div class="impl-items"><section id="method.to_id" class="method"><a class="src rightside" href="../../src/azalea_core/game_type.rs.html#18-25">Source</a><h4 class="code-header">pub fn <a href="#method.to_id" class="fn">to_id</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></h4></section><details class="toggle method-toggle" open><summary><section id="method.to_optional_id" class="method"><a class="src rightside" href="../../src/azalea_core/game_type.rs.html#28-33">Source</a><h4 class="code-header">pub fn <a href="#method.to_optional_id" class="fn">to_optional_id</a>&lt;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="enum.GameMode.html" title="enum azalea_core::game_type::GameMode">GameMode</a>&gt;&gt;&gt;(game_type: T) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></h4></section></summary><div class="docblock"><p>Get the id of the game type, but return -1 if the game type is invalid.</p>
</div></details><section id="method.from_id" class="method"><a class="src rightside" href="../../src/azalea_core/game_type.rs.html#35-43">Source</a><h4 class="code-header">pub fn <a href="#method.from_id" class="fn">from_id</a>(id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="enum.GameMode.html" title="enum azalea_core::game_type::GameMode">GameMode</a>&gt;</h4></section><section id="method.from_optional_id" class="method"><a class="src rightside" href="../../src/azalea_core/game_type.rs.html#45-53">Source</a><h4 class="code-header">pub fn <a href="#method.from_optional_id" class="fn">from_optional_id</a>(id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.OptionalGameType.html" title="struct azalea_core::game_type::OptionalGameType">OptionalGameType</a>&gt;</h4></section><details class="toggle method-toggle" open><summary><section id="method.short_name" class="method"><a class="src rightside" href="../../src/azalea_core/game_type.rs.html#56-58">Source</a><h4 class="code-header">pub fn <a href="#method.short_name" class="fn">short_name</a>(&amp;self) -&gt; TranslatableComponent</h4></section></summary><div class="docblock"><p>The short translatable display name for the gamemode, like “Survival”.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.long_name" class="method"><a class="src rightside" href="../../src/azalea_core/game_type.rs.html#62-64">Source</a><h4 class="code-header">pub fn <a href="#method.long_name" class="fn">long_name</a>(&amp;self) -&gt; TranslatableComponent</h4></section></summary><div class="docblock"><p>The long translatable display name for the gamemode, like “Survival
</div></details><section id="method.from_id" class="method"><a class="src rightside" href="../../src/azalea_core/game_type.rs.html#35-43">Source</a><h4 class="code-header">pub fn <a href="#method.from_id" class="fn">from_id</a>(id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="enum.GameMode.html" title="enum azalea_core::game_type::GameMode">GameMode</a>&gt;</h4></section><section id="method.from_optional_id" class="method"><a class="src rightside" href="../../src/azalea_core/game_type.rs.html#45-53">Source</a><h4 class="code-header">pub fn <a href="#method.from_optional_id" class="fn">from_optional_id</a>(id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.OptionalGameType.html" title="struct azalea_core::game_type::OptionalGameType">OptionalGameType</a>&gt;</h4></section><details class="toggle method-toggle" open><summary><section id="method.short_name" class="method"><a class="src rightside" href="../../src/azalea_core/game_type.rs.html#56-58">Source</a><h4 class="code-header">pub fn <a href="#method.short_name" class="fn">short_name</a>(&amp;self) -&gt; <a class="struct" href="../../azalea_chat/translatable_component/struct.TranslatableComponent.html" title="struct azalea_chat::translatable_component::TranslatableComponent">TranslatableComponent</a></h4></section></summary><div class="docblock"><p>The short translatable display name for the gamemode, like “Survival”.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.long_name" class="method"><a class="src rightside" href="../../src/azalea_core/game_type.rs.html#62-64">Source</a><h4 class="code-header">pub fn <a href="#method.long_name" class="fn">long_name</a>(&amp;self) -&gt; <a class="struct" href="../../azalea_chat/translatable_component/struct.TranslatableComponent.html" title="struct azalea_chat::translatable_component::TranslatableComponent">TranslatableComponent</a></h4></section></summary><div class="docblock"><p>The long translatable display name for the gamemode, like “Survival
Mode”.</p>
</div></details><section id="method.from_name" class="method"><a class="src rightside" href="../../src/azalea_core/game_type.rs.html#66-74">Source</a><h4 class="code-header">pub fn <a href="#method.from_name" class="fn">from_name</a>(name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; <a class="enum" href="enum.GameMode.html" title="enum azalea_core::game_type::GameMode">GameMode</a></h4></section><details class="toggle method-toggle" open><summary><section id="method.name" class="method"><a class="src rightside" href="../../src/azalea_core/game_type.rs.html#77-84">Source</a><h4 class="code-header">pub fn <a href="#method.name" class="fn">name</a>(&amp;self) -&gt; &amp;'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section></summary><div class="docblock"><p>The internal name for the game mode, like “survival”.</p>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-GameMode-1" class="impl"><a class="src rightside" href="../../src/azalea_core/game_type.rs.html#87-94">Source</a><a href="#impl-GameMode-1" class="anchor">§</a><h3 class="code-header">impl <a class="enum" href="enum.GameMode.html" title="enum azalea_core::game_type::GameMode">GameMode</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.is_block_placing_restricted" class="method"><a class="src rightside" href="../../src/azalea_core/game_type.rs.html#91-93">Source</a><h4 class="code-header">pub fn <a href="#method.is_block_placing_restricted" class="fn">is_block_placing_restricted</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Whether the player can’t interact with blocks while in this game mode.</p>
Expand Down
4 changes: 2 additions & 2 deletions main/azalea_physics/collision/fn.move_colliding.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
_mover_type: <a class="enum" href="enum.MoverType.html" title="enum azalea_physics::collision::MoverType">MoverType</a>,
movement: &amp;<a class="struct" href="../../azalea_core/position/struct.Vec3.html" title="struct azalea_core::position::Vec3">Vec3</a>,
world: &amp;<a class="struct" href="../../azalea_world/world/struct.Instance.html" title="struct azalea_world::world::Instance">Instance</a>,
position: &amp;mut Mut&lt;'_, Position&gt;,
physics: &amp;mut Physics,
position: &amp;mut Mut&lt;'_, <a class="struct" href="../../azalea_entity/struct.Position.html" title="struct azalea_entity::Position">Position</a>&gt;,
physics: &amp;mut <a class="struct" href="../../azalea_entity/struct.Physics.html" title="struct azalea_entity::Physics">Physics</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../azalea_world/enum.MoveEntityError.html" title="enum azalea_world::MoveEntityError">MoveEntityError</a>&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Move an entity by a given delta, checking for collisions.</p>
<p>In Mojmap, this is <code>Entity.move</code>.</p>
</div></details></section></div></main></body></html>
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `update_in_water_state_and_do_fluid_pushing` fn in crate `azalea_physics`."><title>update_in_water_state_and_do_fluid_pushing in azalea_physics::fluids - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="azalea_physics" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0-nightly (824759493 2025-01-09)" data-channel="nightly" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../azalea_physics/index.html">azalea_<wbr>physics</a><span class="version">0.11.0+mc1.21.4</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In azalea_<wbr>physics::<wbr>fluids</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">azalea_physics</a>::<wbr><a href="index.html">fluids</a></span><h1>Function <span class="fn">update_in_water_state_and_do_fluid_pushing</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/azalea_physics/fluids.rs.html#16-52">Source</a> </span></div><pre class="rust item-decl"><code>pub fn update_in_water_state_and_do_fluid_pushing(
query: Query&lt;'_, '_, (&amp;mut Physics, &amp;Position, &amp;<a class="struct" href="../../azalea_world/container/struct.InstanceName.html" title="struct azalea_world::container::InstanceName">InstanceName</a>), (With&lt;LocalEntity&gt;, With&lt;InLoadedChunk&gt;)&gt;,
query: Query&lt;'_, '_, (&amp;mut <a class="struct" href="../../azalea_entity/struct.Physics.html" title="struct azalea_entity::Physics">Physics</a>, &amp;<a class="struct" href="../../azalea_entity/struct.Position.html" title="struct azalea_entity::Position">Position</a>, &amp;<a class="struct" href="../../azalea_world/container/struct.InstanceName.html" title="struct azalea_world::container::InstanceName">InstanceName</a>), (With&lt;<a class="struct" href="../../azalea_entity/struct.LocalEntity.html" title="struct azalea_entity::LocalEntity">LocalEntity</a>&gt;, With&lt;<a class="struct" href="../../azalea_entity/plugin/struct.InLoadedChunk.html" title="struct azalea_entity::plugin::InLoadedChunk">InLoadedChunk</a>&gt;)&gt;,
instance_container: Res&lt;'_, <a class="struct" href="../../azalea_world/container/struct.InstanceContainer.html" title="struct azalea_world::container::InstanceContainer">InstanceContainer</a>&gt;,
)</code></pre></section></div></main></body></html>
2 changes: 1 addition & 1 deletion main/azalea_physics/fn.ai_step.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Applies air resistance and handles jumping."><title>ai_step in azalea_physics - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="azalea_physics" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0-nightly (824759493 2025-01-09)" data-channel="nightly" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../azalea_physics/index.html">azalea_<wbr>physics</a><span class="version">0.11.0+mc1.21.4</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">azalea_physics</a></span><h1>Function <span class="fn">ai_step</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/azalea_physics/lib.rs.html#61-144">Source</a> </span></div><pre class="rust item-decl"><code>pub fn ai_step(
query: Query&lt;'_, '_, (&amp;mut Physics, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;Jumping&gt;, &amp;Position, &amp;LookDirection, &amp;Sprinting, &amp;<a class="struct" href="../azalea_world/container/struct.InstanceName.html" title="struct azalea_world::container::InstanceName">InstanceName</a>), (With&lt;LocalEntity&gt;, With&lt;InLoadedChunk&gt;)&gt;,
query: Query&lt;'_, '_, (&amp;mut <a class="struct" href="../azalea_entity/struct.Physics.html" title="struct azalea_entity::Physics">Physics</a>, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="../azalea_entity/struct.Jumping.html" title="struct azalea_entity::Jumping">Jumping</a>&gt;, &amp;<a class="struct" href="../azalea_entity/struct.Position.html" title="struct azalea_entity::Position">Position</a>, &amp;<a class="struct" href="../azalea_entity/struct.LookDirection.html" title="struct azalea_entity::LookDirection">LookDirection</a>, &amp;<a class="struct" href="../azalea_entity/metadata/struct.Sprinting.html" title="struct azalea_entity::metadata::Sprinting">Sprinting</a>, &amp;<a class="struct" href="../azalea_world/container/struct.InstanceName.html" title="struct azalea_world::container::InstanceName">InstanceName</a>), (With&lt;<a class="struct" href="../azalea_entity/struct.LocalEntity.html" title="struct azalea_entity::LocalEntity">LocalEntity</a>&gt;, With&lt;<a class="struct" href="../azalea_entity/plugin/struct.InLoadedChunk.html" title="struct azalea_entity::plugin::InLoadedChunk">InLoadedChunk</a>&gt;)&gt;,
instance_container: Res&lt;'_, <a class="struct" href="../azalea_world/container/struct.InstanceContainer.html" title="struct azalea_world::container::InstanceContainer">InstanceContainer</a>&gt;,
)</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Applies air resistance and handles jumping.</p>
<p>Happens before <a href="travel/fn.travel.html" title="fn azalea_physics::travel::travel"><code>travel::travel</code></a>.</p>
Expand Down
Loading

0 comments on commit f812d78

Please sign in to comment.