Merge pull request #144 from stride3d/master

Releasing recent docs updates

.github/workflows/stride-docs-wiki.yml

@@ -2,14 +2,14 @@ name: Publish to GitHub Wiki
 on:
   push:
     branches:
-      - staging
+      - master
     paths:
       - wiki/**
   workflow_dispatch:
 
 jobs:
   build:
-    #if: github.repository == 'stride3d/stride-docs'
+    if: github.repository == 'stride3d/stride-docs'
     runs-on: ubuntu-latest
 
     steps:
@@ -22,4 +22,4 @@ jobs:
          ACTION_NAME: VaclavElias
          OWNER: ${{ github.repository_owner }}
          REPO_NAME: ${{ github.event.repository.name }}
-         MD_FOLDER: wiki
+         MD_FOLDER: wiki

BuildDocs.ps1

@@ -6,9 +6,9 @@
 .NOTES
     The documentation files are expected to be in Markdown format (.md). The script uses the DocFX tool to build the documentation and optionally includes API documentation. The script generates the API documentation from C# source files using DocFX metadata and can run a local website using the DocFX serve command. This script can also be run from GitHub Actions.
 .LINK
-    https://github.com/VaclavElias/stride-website-next
+    https://github.com/stride3d/stride-docs
 .LINK
-    https://github.com/VaclavElias/stride-docs-next/blob/main/en/languages.json
+    https://github.com/stride3d/stride-docs/blob/master/en/languages.json
 .LINK
     https://dotnet.github.io/docfx/index.html
 .PARAMETER BuildAll

README.md

@@ -10,7 +10,7 @@ Welcome to the Stride Docs repository. This repository contains all the source f
 
 ## 🚀 Getting Started
 
-All the information you need to get started with Stride Docs development can be found in the 📚 [Stride Docs Wiki](https://github.com/VaclavElias/stride-docs-next/wiki).
+All the information you need to get started with Stride Docs development can be found in the 📚 [Stride Docs Wiki](https://github.com/stride3d/stride-docs/wiki).
 
 ## 🤝 Contributing
 
@@ -31,11 +31,11 @@ Stride Docs website is _not_ released under a regular cadence; new updates arriv
 
 The staging website allows us to test new features and significant changes before their official release.
 
-The staging website is available at https://stride-docs-staging.azurewebsites.net/
+The staging website is available at https://stride-doc-staging.azurewebsites.net/
 
 ## 🗺️ Roadmap
 
-Our Wiki [Roadmap](https://github.com/VaclavElias/stride-docs-next/wiki/Roadmap) communicates upcoming changes to the Stride Docs.
+Our Wiki [Roadmap](https://github.com/stride3d/stride-docs/wiki/Roadmap) communicates upcoming changes to the Stride Docs.
 
 ## 🌐 .NET Foundation
 
@@ -61,4 +61,4 @@ Don't forget to change `$version` in [deploy.ps1](build/deploy.ps1) when branchi
 
 ### Manage multiple Stride versions
 
-Each Stride minor version (i.e. 4.0, 4.1, etc.) should have its own branch, named in the fashion `master-<version>`. The only exception is latest version, which should be `master`.
+Each Stride minor version (i.e. 4.0, 4.1, etc.) should have its own branch, named in the fashion `master-<version>`. The only exception is latest version, which should be `master`.

en/diagnostics/strd001.md

@@ -1,6 +1,6 @@
 # Diagnostics Warning STRD001
 
-The Property `Array` has an invalid Access Type for an Array, expected for Arrays is public/internal get, Accessor, Stride will..
+An Array must have a public/internal getter for Serialization.
 
 ## Example
 
@@ -50,5 +50,5 @@ The `break` statement cannot be reached because it occurs after the `return` sta
 
 ## See also
 
-[C# Compiler Options](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-options/)
-[C# Compiler Errors](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/)
+- [C# Compiler Options](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-options/)
+- [C# Compiler Errors](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/)

en/diagnostics/strd002.md

@@ -0,0 +1,54 @@
+# Diagnostics Warning STRD002
+
+A collection must have a public/internal getter for Serialization.
+
+## Example
+
+The following example generates STRD001:
+
+```csharp
+// STRD001.cs
+// compile with: /W:2
+public class Program
+{
+    public static void Main()
+    {
+        goto lab1;
+        {
+            // The following statements cannot be reached:
+            int i = 9;   // STRD001
+            i++;
+        }
+    lab1:
+        {
+        }
+    }
+}
+
+```
+
+Another common example where this error is generated is as follows:
+
+```csharp
+public static class Class1
+{
+    public static string Method1()
+    {
+        string x = "a";
+        switch (x)
+        {
+            case "a":
+                return "a";
+                break;          // CS0162
+        }
+        return "";
+    }
+}
+```
+
+The `break` statement cannot be reached because it occurs after the `return` statement. The `return` statement ends the enclosing `case` branch.
+
+## See also
+
+- [C# Compiler Options](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-options/)
+- [C# Compiler Errors](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/)

en/diagnostics/strd003.md

@@ -0,0 +1,56 @@
+# Diagnostics Warning STRD003
+
+- A property must have a public/internal getter.
+- A property must be set during instantiation, then no public setter would be valid.
+- Or it must have a public setter else.
+
+## Example
+
+The following example generates STRD001:
+
+```csharp
+// STRD001.cs
+// compile with: /W:2
+public class Program
+{
+    public static void Main()
+    {
+        goto lab1;
+        {
+            // The following statements cannot be reached:
+            int i = 9;   // STRD001
+            i++;
+        }
+    lab1:
+        {
+        }
+    }
+}
+
+```
+
+Another common example where this error is generated is as follows:
+
+```csharp
+public static class Class1
+{
+    public static string Method1()
+    {
+        string x = "a";
+        switch (x)
+        {
+            case "a":
+                return "a";
+                break;          // CS0162
+        }
+        return "";
+    }
+}
+```
+
+The `break` statement cannot be reached because it occurs after the `return` statement. The `return` statement ends the enclosing `case` branch.
+
+## See also
+
+- [C# Compiler Options](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-options/)
+- [C# Compiler Errors](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/)

en/diagnostics/strd004.md

@@ -0,0 +1,54 @@
+# Diagnostics Warning STRD004
+
+For <see cref="System.Collections.Generic.Dictionary{TKey, TValue}"/> the only valid Keys are primitive Types. All complex types like custom structs, objects are not allowed.
+
+## Example
+
+The following example generates STRD001:
+
+```csharp
+// STRD001.cs
+// compile with: /W:2
+public class Program
+{
+    public static void Main()
+    {
+        goto lab1;
+        {
+            // The following statements cannot be reached:
+            int i = 9;   // STRD001
+            i++;
+        }
+    lab1:
+        {
+        }
+    }
+}
+
+```
+
+Another common example where this error is generated is as follows:
+
+```csharp
+public static class Class1
+{
+    public static string Method1()
+    {
+        string x = "a";
+        switch (x)
+        {
+            case "a":
+                return "a";
+                break;          // CS0162
+        }
+        return "";
+    }
+}
+```
+
+The `break` statement cannot be reached because it occurs after the `return` statement. The `return` statement ends the enclosing `case` branch.
+
+## See also
+
+- [C# Compiler Options](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-options/)
+- [C# Compiler Errors](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/)

en/diagnostics/strd007.md

@@ -0,0 +1,54 @@
+# Diagnostics Warning STRD007
+
+It's invalid to DataMember a private property. Also its invalid to DataMember a property which has DataMemberIgnore.
+
+## Example
+
+The following example generates STRD001:
+
+```csharp
+// STRD001.cs
+// compile with: /W:2
+public class Program
+{
+    public static void Main()
+    {
+        goto lab1;
+        {
+            // The following statements cannot be reached:
+            int i = 9;   // STRD001
+            i++;
+        }
+    lab1:
+        {
+        }
+    }
+}
+
+```
+
+Another common example where this error is generated is as follows:
+
+```csharp
+public static class Class1
+{
+    public static string Method1()
+    {
+        string x = "a";
+        switch (x)
+        {
+            case "a":
+                return "a";
+                break;          // CS0162
+        }
+        return "";
+    }
+}
+```
+
+The `break` statement cannot be reached because it occurs after the `return` statement. The `return` statement ends the enclosing `case` branch.
+
+## See also
+
+- [C# Compiler Options](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-options/)
+- [C# Compiler Errors](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/)

en/diagnostics/toc.md

@@ -1,3 +1,7 @@
 # [Diagnostics](index.md)
 
-# [STRD001](strd001.md)
+# [STRD001](strd001.md)
+# [STRD002](strd002.md)
+# [STRD003](strd003.md)
+# [STRD004](strd004.md)
+# [STRD007](strd007.md)

en/docfx.json

@@ -57,7 +57,11 @@
       "_appTitle": "Stride Docs",
       "_enableSearch": true,
       "_appLogoPath": "media/stride-logo-red.svg",
-      "_appFooter": "<div class=\"d-flex flex-column flex-sm-row justify-content-between pt-1 text-center small\"><p >Supported by the <a href=\"https://dotnetfoundation.org/\" target=\"_blank\" rel=\"noopener\">.NET Foundation</a></p><p>Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a></p><p >Stride Docs Website v.2.0.0.5</p><p>&copy; .NET Foundation and Contributors</p></div>"
+      "_appFooter": "<div class=\"d-flex flex-column flex-sm-row justify-content-between pt-1 text-center small\"><p >Supported by the <a href=\"https://dotnetfoundation.org/\" target=\"_blank\" rel=\"noopener\">.NET Foundation</a></p><p>Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a></p><p >Stride Docs Website v.2.0.0.5</p><p>&copy; .NET Foundation and Contributors</p></div>",
+      "_gitContribute": {
+        "repo": "https://github.com/stride3d/stride-docs",
+        "branch": "master"
+      }
     },
     "fileMetadata": {
       "_appTitle": {

en/manual/files-and-folders/distribute-a-game.md

@@ -37,6 +37,16 @@ When you're ready to publish your game, create a release build from Visual Studi
 > [!Tip]
 > You might want to rename the **Release** folder to something more descriptive (such as the title of your game).
 
+## To build using terminal instead of VS
+
+ 1. You would need to install VS to get **Developer Command Propmt for VS (Version)**
+ 2. This is needed to run the msbuild command
+
+ 3. The following command is to build the project to a folder of your choosing
+ 4. ```console
+    C:\User> msbuild PathToSln\NameOfProject.sln /p:Configuration=Release /p:OutputPath=YourPreferredPath
+    ```
+
 ## 2. Delete unnecessary files
 
 In the release folder in your project bin folder (eg *MyGame/Bin/MyPlatform/Release*), you can delete the following unnecessary files:
@@ -67,4 +77,4 @@ To run games made with Stride on Windows, users need:
 
 * [Add or remove a platform](../platforms/add-or-remove-a-platform.md)
 * [Version control](version-control.md)
-* [Project structure](project-structure.md)
+* [Project structure](project-structure.md)

en/manual/physics/raycasting.md

@@ -47,5 +47,11 @@ public static bool ScreenPositionToWorldPositionRaycast(Vector2 screenPos, Camer
 }
 ```
 
+>[!Note]
+>There are multiple ways to retrieve a reference to this `Simulation` from inside one of your `ScriptComponent`:
+>- The recommended way is through a reference to a physics component, something like `myRigidBody.Simulation` or `myCollision.Simulation` as it is the fastest.
+>- Then through `SceneSystem` by calling `SceneSystem.SceneInstance.GetProcessor<PhysicsProcessor>()?.Simulation`.
+>- Or through `this.GetSimulation()`, note that the `this` is required as it is an extension method.
+
 ## See also
 * [Colliders](colliders.md)