Skip to content

Commit

Permalink
deploy: a421c82
Browse files Browse the repository at this point in the history
  • Loading branch information
@VaclavElias
VaclavElias committed Oct 17, 2023
1 parent 2e0ba29 commit c953c56
Show file tree
Hide file tree
Showing 15 changed files with 342 additions and 166 deletions.
14 changes: 7 additions & 7 deletions api/Stride.CommunityToolkit.Engine.EntityExtensions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,25 +133,25 @@ <h2 class="section" id="methods">Methods
</h2>


<a id="Stride_CommunityToolkit_Engine_EntityExtensions_AddMouseLookCamera_" data-uid="Stride.CommunityToolkit.Engine.EntityExtensions.AddMouseLookCamera*"></a>
<a id="Stride_CommunityToolkit_Engine_EntityExtensions_AddInteractiveCameraScript_" data-uid="Stride.CommunityToolkit.Engine.EntityExtensions.AddInteractiveCameraScript*"></a>

<h3 id="Stride_CommunityToolkit_Engine_EntityExtensions_AddMouseLookCamera_Stride_Engine_Entity_" data-uid="Stride.CommunityToolkit.Engine.EntityExtensions.AddMouseLookCamera(Stride.Engine.Entity)">
AddMouseLookCamera(Entity)
<h3 id="Stride_CommunityToolkit_Engine_EntityExtensions_AddInteractiveCameraScript_Stride_Engine_Entity_" data-uid="Stride.CommunityToolkit.Engine.EntityExtensions.AddInteractiveCameraScript(Stride.Engine.Entity)">
AddInteractiveCameraScript(Entity)
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/EntityExtensions.cs/#L19"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Adds a mouse-look camera controller to the specified entity, enabling camera movement and rotation through various input methods.</p>
<div class="markdown level1 summary"><p>Adds an interactive camera script to the specified entity, enabling camera movement and rotation through various input methods.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void AddMouseLookCamera(this Entity entity)</code></pre>
<pre><code class="lang-csharp hljs">public static void AddInteractiveCameraScript(this Entity entity)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>entity</code> <a class="xref" href="https://github.com/stride3d/stride/blob/02f6a1ef77ed604675df7fc4501d68a3875c68e3/sources/engine/Stride.Engine/Engine/Entity.cs">Entity</a></dt>
<dd><p>The entity to which the camera controller will be added.</p>
<dd><p>The entity to which the interactive camera script will be added.</p>
</dd>
</dl>

Expand All @@ -162,7 +162,7 @@ <h4 class="section">Parameters</h4>



<h4 class="section" id="Stride_CommunityToolkit_Engine_EntityExtensions_AddMouseLookCamera_Stride_Engine_Entity__remarks">Remarks</h4>
<h4 class="section" id="Stride_CommunityToolkit_Engine_EntityExtensions_AddInteractiveCameraScript_Stride_Engine_Entity__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>The camera entity can be moved using W, A, S, D, Q and E, arrow keys, a gamepad's left stick or dragging/scaling using multi-touch.
Rotation is achieved using the Numpad, the mouse while holding the right mouse button, a gamepad's right stick, or dragging using single-touch.</p>
</div>
Expand Down
82 changes: 52 additions & 30 deletions api/Stride.CommunityToolkit.Engine.GameExtensions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ <h4 class="section" id="Stride_CommunityToolkit_Engine_GameExtensions_AddCamera_

<h3 id="Stride_CommunityToolkit_Engine_GameExtensions_AddDirectionalLight_Stride_Engine_Game_System_String_" data-uid="Stride.CommunityToolkit.Engine.GameExtensions.AddDirectionalLight(Stride.Engine.Game,System.String)">
AddDirectionalLight(Game, string?)
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L196"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L176"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Adds a directional light entity to the game's root scene with optional customization.</p>
Expand Down Expand Up @@ -282,7 +282,7 @@ <h4 class="section">Returns</h4>

<h3 id="Stride_CommunityToolkit_Engine_GameExtensions_AddGround_Stride_Engine_Game_System_String_System_Nullable_Stride_Core_Mathematics_Vector2__System_Boolean_" data-uid="Stride.CommunityToolkit.Engine.GameExtensions.AddGround(Stride.Engine.Game,System.String,System.Nullable{Stride.Core.Mathematics.Vector2},System.Boolean)">
AddGround(Game, string?, Vector2?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L268"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L248"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Adds a ground with default Size 10,10.</p>
Expand Down Expand Up @@ -326,10 +326,12 @@ <h4 class="section">Returns</h4>

<h3 id="Stride_CommunityToolkit_Engine_GameExtensions_AddProfiler_Stride_Engine_Game_System_String_" data-uid="Stride.CommunityToolkit.Engine.GameExtensions.AddProfiler(Stride.Engine.Game,System.String)">
AddProfiler(Game, string?)
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L344"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L355"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Toggle profiling Left Shift + Left Ctrl + P, Toggle filtering mode F1</p>
<div class="markdown level1 summary"><p>Adds a profiler to the game, which can be toggled on/off with Left Shift + Left Ctrl + P, and provides other keyboard shortcuts.
Changing the filtering mode with F1, altering the sorting mode with F2, navigating result pages with F3 and F4,
and adjusting the refresh interval with the plus and minus keys.</p>
</div>
<div class="markdown level1 conceptual"></div>

Expand All @@ -340,15 +342,18 @@ <h3 id="Stride_CommunityToolkit_Engine_GameExtensions_AddProfiler_Stride_Engine_
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>game</code> <a class="xref" href="https://github.com/stride3d/stride/blob/02f6a1ef77ed604675df7fc4501d68a3875c68e3/sources/engine/Stride.Engine/Engine/Game.cs">Game</a></dt>
<dd></dd>
<dd><p>The game to which the profiler will be added.</p>
</dd>
<dt><code>entityName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>Optional name for the entity to which the <a class="xref" href="Stride.CommunityToolkit.Scripts.GameProfiler.html">GameProfiler</a> script will be attached.</p>
</dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://github.com/stride3d/stride/blob/02f6a1ef77ed604675df7fc4501d68a3875c68e3/sources/engine/Stride.Engine/Engine/Entity.cs">Entity</a></dt>
<dd></dd>
<dd><p>The entity to which the <a class="xref" href="Stride.CommunityToolkit.Scripts.GameProfiler.html">GameProfiler</a> script was attached.</p>
</dd>
</dl>


Expand All @@ -357,6 +362,10 @@ <h4 class="section">Returns</h4>



<h4 class="section" id="Stride_CommunityToolkit_Engine_GameExtensions_AddProfiler_Stride_Engine_Game_System_String__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>This extension method creates an entity and attaches a <a class="xref" href="Stride.CommunityToolkit.Scripts.GameProfiler.html">GameProfiler</a> script to it, enabling in-game profiling.
The profiler's behaviour can be interacted with using various keyboard shortcuts as described in the <a class="xref" href="Stride.CommunityToolkit.Scripts.GameProfiler.html">GameProfiler</a> class.</p>
</div>



Expand All @@ -365,7 +374,7 @@ <h4 class="section">Returns</h4>

<h3 id="Stride_CommunityToolkit_Engine_GameExtensions_AddSkybox_Stride_Engine_Game_System_String_" data-uid="Stride.CommunityToolkit.Engine.GameExtensions.AddSkybox(Stride.Engine.Game,System.String)">
AddSkybox(Game, string?)
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L234"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L214"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Adds a skybox to the specified game scene, providing a background texture to create a more immersive environment.</p>
Expand Down Expand Up @@ -412,10 +421,10 @@ <h4 class="section" id="Stride_CommunityToolkit_Engine_GameExtensions_AddSkybox_

<h3 id="Stride_CommunityToolkit_Engine_GameExtensions_CreateMaterial_Stride_Engine_Game_System_Nullable_Stride_Core_Mathematics_Color__System_Single_System_Single_" data-uid="Stride.CommunityToolkit.Engine.GameExtensions.CreateMaterial(Stride.Engine.Game,System.Nullable{Stride.Core.Mathematics.Color},System.Single,System.Single)">
CreateMaterial(Game, Color?, float, float)
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L287"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L289"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Basic default material</p>
<div class="markdown level1 summary"><p>Creates a basic material with optional color, specular reflection, and microsurface smoothness values.</p>
</div>
<div class="markdown level1 conceptual"></div>

Expand All @@ -426,19 +435,24 @@ <h3 id="Stride_CommunityToolkit_Engine_GameExtensions_CreateMaterial_Stride_Engi
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>game</code> <a class="xref" href="https://github.com/stride3d/stride/blob/02f6a1ef77ed604675df7fc4501d68a3875c68e3/sources/engine/Stride.Engine/Engine/Game.cs">Game</a></dt>
<dd></dd>
<dd><p>The game instance used to access the graphics device.</p>
</dd>
<dt><code>color</code> <a class="xref" href="https://github.com/stride3d/stride/blob/02f6a1ef77ed604675df7fc4501d68a3875c68e3/sources/core/Stride.Core.Mathematics/Color.Palette.cs">Color</a>?</dt>
<dd></dd>
<dd><p>The color of the material. Defaults to null, which will use the _defaultMaterialColor.</p>
</dd>
<dt><code>specular</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.single">float</a></dt>
<dd></dd>
<dd><p>The specular reflection factor of the material. Defaults to 1.0f.</p>
</dd>
<dt><code>microSurface</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.single">float</a></dt>
<dd></dd>
<dd><p>The microsurface smoothness value of the material. Defaults to 0.65f.</p>
</dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://github.com/stride3d/stride/blob/02f6a1ef77ed604675df7fc4501d68a3875c68e3/sources/engine/Stride.Rendering/Rendering/Material.cs">Material</a></dt>
<dd></dd>
<dd><p>A new material instance with the specified or default attributes.</p>
</dd>
</dl>


Expand All @@ -455,10 +469,10 @@ <h4 class="section">Returns</h4>

<h3 id="Stride_CommunityToolkit_Engine_GameExtensions_CreatePrimitive_Stride_Engine_Game_Stride_CommunityToolkit_ProceduralModels_PrimitiveModelType_System_String_Stride_Rendering_Material_System_Boolean_System_Nullable_Stride_Core_Mathematics_Vector2__" data-uid="Stride.CommunityToolkit.Engine.GameExtensions.CreatePrimitive(Stride.Engine.Game,Stride.CommunityToolkit.ProceduralModels.PrimitiveModelType,System.String,Stride.Rendering.Material,System.Boolean,System.Nullable{Stride.Core.Mathematics.Vector2})">
CreatePrimitive(Game, PrimitiveModelType, string?, Material?, bool, Vector2?)
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L313"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L316"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Creates an entity with a primitive procedural model with a primitive mesh renderer and adds appropriate collider except for Torus, Teapot and Plane.</p>
<div class="markdown level1 summary"><p>Creates a primitive 3D model entity of the specified type with optional customizations.</p>
</div>
<div class="markdown level1 conceptual"></div>

Expand All @@ -469,24 +483,30 @@ <h3 id="Stride_CommunityToolkit_Engine_GameExtensions_CreatePrimitive_Stride_Eng
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>game</code> <a class="xref" href="https://github.com/stride3d/stride/blob/02f6a1ef77ed604675df7fc4501d68a3875c68e3/sources/engine/Stride.Engine/Engine/Game.cs">Game</a></dt>
<dd></dd>
<dd><p>The game instance.</p>
</dd>
<dt><code>type</code> <a class="xref" href="Stride.CommunityToolkit.ProceduralModels.PrimitiveModelType.html">PrimitiveModelType</a></dt>
<dd></dd>
<dd><p>The type of primitive model to create.</p>
</dd>
<dt><code>entityName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The name to assign to the new entity (optional).</p>
</dd>
<dt><code>material</code> <a class="xref" href="https://github.com/stride3d/stride/blob/02f6a1ef77ed604675df7fc4501d68a3875c68e3/sources/engine/Stride.Rendering/Rendering/Material.cs">Material</a></dt>
<dd></dd>
<dd><p>The material to apply to the model (optional).</p>
</dd>
<dt><code>includeCollider</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>Adds a default collider except for Torus, Teapot and Plane. Default true.</p>
<dd><p>Indicates whether to include a collider component (default is true).</p>
</dd>
<dt><code>size</code> <a class="xref" href="https://github.com/stride3d/stride/blob/02f6a1ef77ed604675df7fc4501d68a3875c68e3/sources/core/Stride.Core.Mathematics/Vector2.cs">Vector2</a>?</dt>
<dd></dd>
<dd><p>The size of the model if applicable (optional).</p>
</dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://github.com/stride3d/stride/blob/02f6a1ef77ed604675df7fc4501d68a3875c68e3/sources/engine/Stride.Engine/Engine/Entity.cs">Entity</a></dt>
<dd></dd>
<dd><p>A new entity representing the specified primitive model.</p>
</dd>
</dl>


Expand All @@ -503,7 +523,7 @@ <h4 class="section">Returns</h4>

<h3 id="Stride_CommunityToolkit_Engine_GameExtensions_DeltaTime_Stride_Games_IGame_" data-uid="Stride.CommunityToolkit.Engine.GameExtensions.DeltaTime(Stride.Games.IGame)">
DeltaTime(IGame)
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L164"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L266"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets the time elapsed since the last game update in seconds as a single-precision floating-point number.</p>
Expand Down Expand Up @@ -542,7 +562,7 @@ <h4 class="section">Returns</h4>

<h3 id="Stride_CommunityToolkit_Engine_GameExtensions_DeltaTimeAccurate_Stride_Games_IGame_" data-uid="Stride.CommunityToolkit.Engine.GameExtensions.DeltaTimeAccurate(Stride.Games.IGame)">
DeltaTimeAccurate(IGame)
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L174"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L276"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets the time elapsed since the last game update in seconds as a double-precision floating-point number.</p>
Expand Down Expand Up @@ -581,10 +601,10 @@ <h4 class="section">Returns</h4>

<h3 id="Stride_CommunityToolkit_Engine_GameExtensions_FPS_Stride_Engine_Game_" data-uid="Stride.CommunityToolkit.Engine.GameExtensions.FPS(Stride.Engine.Game)">
FPS(Game)
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L390"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Engine/GameExtensions.cs/#L401"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Shows the current FPS.</p>
<div class="markdown level1 summary"><p>Retrieves the current frames per second (FPS) rate of the running game.</p>
</div>
<div class="markdown level1 conceptual"></div>

Expand All @@ -595,13 +615,15 @@ <h3 id="Stride_CommunityToolkit_Engine_GameExtensions_FPS_Stride_Engine_Game_" d
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>game</code> <a class="xref" href="https://github.com/stride3d/stride/blob/02f6a1ef77ed604675df7fc4501d68a3875c68e3/sources/engine/Stride.Engine/Engine/Game.cs">Game</a></dt>
<dd></dd>
<dd><p>The game instance from which to obtain the FPS rate.</p>
</dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.single">float</a></dt>
<dd></dd>
<dd><p>The current FPS rate of the game.</p>
</dd>
</dl>


Expand Down
Loading

0 comments on commit c953c56

Please sign in to comment.