Register scripts as classes

Godot支持名为“Script Class”的特性允许我们将个人的脚本注册给godot编辑器使用。而默认情况下，你只能通过直接加载的方式来访问未命名的脚本。
通过在关键字class_name后面添加类名的方式，你可以给一个脚本命名并且将其作为一个类型注册到godot编辑器。你还可以添加一个逗号和可选的图片路径将其作为类的图标。此后你就可以在创建Node和Resource的对话框中找到你新定义的类了。

extends Node

# Declare the class name here
class_name ScriptName, "res://path/to/optional/icon.svg"

func _ready():
    var this = ScriptName           # reference to the script
    var cppNode = MyCppNode.new()   # new instance of a class named MyCppNode

    cppNode.queue_free()

Warning

在 Godot 3.1 中：

• 只有 GDScript 和 NativeScript（C++和其他GDNative-powered的语言），能注册脚本。
• 只有 GDScript会为每个被命名的脚本创建全局变量

参考

[GodotDocs] Scripting (continued)

[Godot] Godot 3 快捷键参考

版本

Godot 3.0.6

常用快捷键

Canvas Item Editor

Animation Player Editor

全部快捷键

Editor-> Editor Settings-> Shortcuts

参考

[GodotQ&A] Undocumented Shortcuts

[GDScript]字典(Dictionary)的顺序

背景介绍

GDScript作为godot首选的脚本语言有着与python类似的语法。Dictionary自然也是必不可少的容器结构。然而多数语言的Dictionary实现通常基于hash table, 无法实现有序排列。通常遇到有序需求时我们会选用Array来替代。

按插入的顺序获取key

godot的Dictionary在3.0版本中追加了一个特性：遍历字典时保持插入顺序。记录以供参考。

例子

var dict = {}
dict["3"] = 1
dict["2"] = 1
dict["4"] = 1
dict["5"] = 1
dict["1"] = 1
dict.erase("4")
dict["4"] = 1

print("dict = ", dict)
for each in dict.keys():
print("curKey = ",each)

输出结果：

dict = (1:1), (2:1), (3:1), (4:1), (5:1)
curKey = 3
curKey = 2
curKey = 5
curKey = 1
curKey = 4

参考

1.[Wikipedia] Hash table
2.[Godot Q&A] Ordering / sorting objects in a dictionary?

Coroutines with yield

GDScript 提供yield内建函数用以支持coroutines。调用yield()将会立刻从当前函数返回，同时将这个函数的当前状态冻结作为返回值。如果之后通过返回值得到的对象调用resume(继续)方法，就会继续从上个冻结状态执行下去并返回下一个返回值。一旦调用过resume方法后，之前的得到的状态对象就失效了。例子如下：

func my_func():
   print("Hello")
   yield()
   print("world")

func _ready():
    var y = my_func()
    # Function state saved in 'y'.
    print("my dear")
    y.resume()
    # 'y' resumed and is now an invalid state.

输出结果：

Hello
my dear
world

在yield()与resume()调用之间我们也可以传递参数，例子如下：

func my_func():
   print("Hello")
   print(yield())
   return "cheers!"

func _ready():
    var y = my_func()
    # Function state saved in 'y'.
    print(y.resume("world"))
    # 'y' resumed and is now an invalid state.

输出结果：

Hello
world
cheers!

Coroutines & signals

与signal(信号)机制结合使用才会发挥yield真正的长处。 yield方法可以接受两个参数，一个对象引用，一个信号名称。效果是：收到该信号时，重新开始执行该协程。例子如下：

# Resume execution the next frame.
yield(get_tree(), "idle_frame")

# Resume execution when animation is done playing.
yield(get_node("AnimationPlayer"), "finished")

# Wait 5 seconds, then resume execution.
yield(get_tree().create_timer(5.0), "timeout")

协程本身使用名为completed的信号来表达他们转移进入了一个无效状态，例子如下：

func my_func():
        yield(button_func(), "completed")
        print("All buttons were pressed, hurray!")

func button_func():
    yield($Button0, "pressed")
        yield($Button1, "pressed")

my_func仅当两个button按钮都被按过以后才会继续执行。

参考

1. [GodotDocs] GDScript
2. [Wikipedia] Coroutine
3. [Wikipedia] Subroutine

一种GDScript语言符号的命名策略

GDScript介绍

GDScript是一种godot游戏引擎所支持的自制的python-like脚本语言，学习成本低，与引擎的功能结合完美，是godot引擎本身“All-in-one”理念所不必可少的组成部分。 在godot项目工程中，由GDScript脚本的后缀名为.gd。

GDScript的几个设计决策

gdscript设计之初便融合于面向对象设计。一个.gd脚本文件即为一个class，如果这个文件依附于某个godot节点，那它便是继承自那个节点类型的派生类。这种设计方式也比较完美的避开了oop程序设计的初学者滥用global变量的风险。Godot依旧设计了Autoload这种方式来的提供那些生命周期与程序一样长的对象实例的访问。

即使是Autoload也无法阻止任何人破坏封装性

然而，gdscript语言不设置任何access modifier(or access specifier). 在这里，我们无法从语言语法规则上指定成员的是否公开还是私有，是否受保护。 类的设计者创建了诸多私有成员，只是因为其中的某些没有设置setter/getter就被其他人（或者几个月后的自己）随意访问的情况几乎无法避免。对于成员函数而言，更是毫无任何办法进行保护。这个小节的标题也正是其中一个后果。

利用命名来表征自己的设计意图

因此，在我的项目中，采用了如下的命名方式来表现设计语义。在语法上没有约束力，只是为了表达更多的语义信息。

• _
  godot内置函数的前缀，如果在你的类中出现了这样的函数，便是进行了一次overwrite,相当于c++中的virtual关键字，java中的默认函数覆写（overwrite）。
• __
  双下划线，表明私有，变量与成员方法均适用。
• 变量名全大写常数。
• 所有export变量均不以 __ 开头

后续效果观察

TBD

参考

[GodotDocs] GDScript

在Godot中利用Tween节点指定Easing function来控制参数的变化曲线

介绍: 什么是Easing function

Easing function 用以描述参数值随时间而改变的变化率。 现实生活中的物体几乎不会以维持常数的速度移动，也不会瞬间开始和停止。当我们打开一个抽屉时，一开始的速度非常快，在拉出来之后慢下来。将物品跌落地板时，它一开始会向下加速，然后在击中地板后回弹。

Easing funcion 是一种描述变化的曲线方程，非常适合用来描绘生动的运动过程。在参考链接中我们可以找到许多有趣的easing function。而Godot的Tween节点也提供了用于指定Easing方式的参数。

Tween节点

godot提供了一种tween节点来简化插值变换的实现。以下代码块是比较常见的用法。

...
onready tween = $Tween

func start():
    tween.interpolate_property(object, “propertyName”, initial_val, final_val, duration, trans_type, ease_type, delay)
    tween.start()
...

被指定的<object> 中名为 <propertyName> 的成员变量将会在<duration>时间内从初始值变化到最终值。具体的插值规则以及曲线的形态由<trans_type>和<ease_type>共同指定。详细的参数描述请见Tween节点的文档中的EaseType和TransitionType两个枚举类型。

enum EaseType:
...
enum TransitionType:
...

组合这两个参数可以实现丰富的变化方式，请自行具体实践。

更加丰富的变化方式

如果Tween节点中所有的预设方式还是无法满足要求，那么我们就可以考虑使用AnimationPlay这个节点了，这个工具最佳情况下允许我们以0.02秒的间隔指定任何property关键变化值，可以满足绝大部分的需求。有机会再单独介绍这个节点。

补充说明：property即为inspector面板上可以看到的任何值。

参考：

1. Easing Functions Cheat Sheet
2. [GodotDocs] Tween

一种Godot项目组织形式

近来启动了一个小型项目，完全采用 godot 3的引擎，旨在验证并探索一个完整游戏开发过程中的模块实现。 为了未来这个项目仍然具备一定的价值，需要一种项目组织形式，以对未来的重构和复用保留灵活性。特此记录个人观点，以便于日后反思修正。

1. 核心思想：

以每个场景的根节点为最小单位，划分独立的文件夹。每个场景文件夹尽可能的拥有独立的assets文件夹，以保留自己的美术资源。

2.根本诉求：

在脱离godot内置编辑器的情况下，可以在操作系统的文件资源理器内以文件夹为单位重新创建新项目作为试验或者复用的沙盒。

3.缺点和优点：

a. 缺点：无法全局管理项目资产
b. 优点：无论是谁，无论开发者自己是否记得住项目组织逻辑，总是可以从一个文件夹入手

4.一些细节应对：

• a. 允许出现一些以分类为目，或是保存基类为目的的文件夹，比如enemy下保有concreteEnemy1，concreteEnemy2文件夹，后两者才是最小组织单位，但是他们可以被放置于一个分类文件夹enemy下（enemy也可能就是他们的基类）。
• b. 如何组织godot的特有资源文件格式tres？与外部的资源文件不同，godot可以保存一种tres格式的资源文件。因其特殊性，建议在每个模块文件夹下单独创建tres文件夹保存他们。所谓tres指的是‘text resource’， 这些配置参数原本内嵌于场景文件中，比如animationPlayer，比如dynamic font， 而godot又允许直接将这些文本形式的内容单独保存成资源文件以方便复用，就有了tres格式，因此tres格式是将“文本配置”视作“资源”的格式，因其特殊性，我希望将他与一般外部资产分离，故选用单独文件夹保存。
• c. 关于模块内资产划分的建议： Texture, Script, Mesh, Animation, AudioStream, Font, Translation等等。

参考：

1. [YouTube] 6 Tips to Better Organize your Godot 3 Projects
2. [GodotDocs] Resources