浏览代码

singletons_autoload.rst: add C# example similar to "Global Variable"

(cherry picked from commit a4e958c0e062c5d42388340baf92a037a3652639)
31 1 年之前
父节点
当前提交
08a0974ecb
共有 1 个文件被更改,包括 27 次插入0 次删除
  1. 27 0
      tutorials/scripting/singletons_autoload.rst

+ 27 - 0
tutorials/scripting/singletons_autoload.rst

@@ -81,6 +81,33 @@ be accessed directly in GDScript:
 
    PlayerVariables.health -= 10
 
+The **Enable** column has no effect in C# code. However, if the singleton is a
+C# script, a similar effect can be achieved by including a static property
+called ``Instance`` and assigning it in ``_Ready()``:
+
+.. tabs::
+ .. code-tab:: csharp
+
+    public partial class PlayerVariables : Node
+    {
+        public static PlayerVariables Instance { get; private set; }
+
+        public int Health { get; set; }
+
+        public override void _Ready()
+        {
+            Instance = this;
+        }
+    }
+
+This allows the singleton to be accessed from C# code without ``GetNode()`` and
+without a typecast:
+
+.. tabs::
+ .. code-tab:: csharp
+
+    PlayerVariables.Instance.Health -= 10;
+
 Note that autoload objects (scripts and/or scenes) are accessed just like any
 other node in the scene tree. In fact, if you look at the running scene tree,
 you'll see the autoloaded nodes appear: