Godot - Revision history

Leo at 05:48, 14 November 2022

2022-11-14T05:48:23Z

@@ Line 128: / Line 128: @@
 # Equivalent to:
 var node = $NodeName
 | lang = gdscript
 }}

Leo: /* GDScript cheatsheet */

2022-11-08T06:40:30Z

GDScript cheatsheet

@@ Line 101: / Line 101: @@
 ## Hints. More in Godot documentation
 export (int, 0, 20) var ZeroToTwenty = 0
 | lang = gdscript
 }}

Leo at 06:31, 8 November 2022

2022-11-08T06:31:44Z

← Older revision		Revision as of 06:31, 8 November 2022
Line 92:		Line 92:
	\|-		\|-
	\|Export variables		\|Export variables
			[https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_exports.html Documentation]
	\|{{Highlight		\|{{Highlight
	\| code = export (int) var WorkTimeStart = 6 * 60		\| code = export (int) var WorkTimeStart = 6 * 60

Leo at 06:29, 8 November 2022

2022-11-08T06:29:58Z

@@ Line 27: / Line 27: @@
 func simple_func3(v = 1):
 	do_something_with(v)
 | lang = gdscript
 }}
@@ Line 67: / Line 78: @@
 var type3 = Type.Blank setget _set_type3
 | lang = gdscript
 }}
 |-
@@ Line 75: / Line 97: @@
 export (Texture)  var building_icon;
 export var size :=  Vector2(1, 1)
 | lang = gdscript
 }}

Leo at 18:46, 6 November 2022

2022-11-06T18:46:03Z

@@ Line 1: / Line 1: @@
-==Concepts==
+Godot is a open source game engine with support for both 2D and 3D based games.
 ===File System===
-The filesystem that Godot provides is res:// for resources such as static game files or assets and user:// for dynamic data such as generated map data or game saves. Addons should be placed in res://addons in your project. Godot converts resource files into its own format and are placed in the res://.import folder.
+The filesystem that Godot provides is <code>res://</code> for resources such as static game files or assets and <code>user://</code> for dynamic data such as generated map data or game saves.
 ===Objects===
-A ''Node'' is the building block of Godot; all scene objects in Godot are Nodes. Nodes have properties and functions and can emit signals which others can subscribe to. Nodes can be assigned as a child of another node and are arranged into a tree. A tree of nodes is referred to as a ''Scene''. Active scenes that are loaded and in use are part of a ''Scene Tree''. In addition to the hierarchy/inheritance model, nodes can also be organized by groups (eg. as groups of Enemies, Collectables, etc. which can be retrieved with <code>get_tree().get_nodes_in_group("enemies")</code>).
+A ''Node'' is the building block of Godot; all scene objects in Godot are Nodes. Nodes have properties and functions and can emit signals which others can subscribe to. Nodes can be assigned as a child of another node and are arranged into a tree.
 A scene is saved to a TSCN (text-scene) file.
@@ Line 19: / Line 104: @@
 ====2D====
-(0, 0) is the top left.
+The 2D coordinate system in Godot is such that:
-Sprite nodes are drawn in the order that they are traversed on the SceneTree. Traversal is done depth-first (TODO: is this right?), meaning the first objects in the tree are drawn first. To switch the draw order, based on its Y position on the screen, use a YSort node (Huh. does this call sort every time something needs to draw? How do we deal with specific ordering otherwise?).
+Sprite nodes are drawn in the order that they are traversed on the SceneTree. Traversal is done depth-first, meaning the first objects in the tree are drawn first. To switch the draw order, based on its Y position on the screen, use a YSort node.
 ===Physics===
@@ Line 38: / Line 126: @@
 ===Tilemap===
 Tilemap or Gridmap can be used to build out the game world. Each uses a Tileset or MeshLibrary (respectively) to build their tiles.
 ==Observations==
@@ Line 71: / Line 155: @@
 #How do we separate business logic from the presentation? It looks like we make models inherit <code>Sprite</code> so that they render so the MV (in MVC) is combined. How does this work if we want, say a 'headless' version of a game?
 #*I suspect that everything even when it inherits a Sprite is treated as a model. Godot then renders everything separately when needed. This removes the dependency on graphical stuff if it isn't needed.
 ==See Also==
 *https://github.com/br-n518/Godot-Beginners-Guide/blob/master/godot_guide.md

Leo at 20:02, 18 October 2020

2020-10-18T20:02:11Z

← Older revision		Revision as of 20:02, 18 October 2020
Line 34:		Line 34:

	Objects belong to one collision layer but can collide with other objects in other layers by setting a collision mask. Objects that can collide can only be moved if they are a KinematicBody or if you manually change the position property of the object.		Objects belong to one collision layer but can collide with other objects in other layers by setting a collision mask. Objects that can collide can only be moved if they are a KinematicBody or if you manually change the position property of the object.



	Tween to make position changes transition smooth?		Tween to make position changes transition smooth?


	~~or more layers. All physics objects specifies which collision layers apply to them.~~

	~~collision layers and collision masks. The collision layer specifies which layer co~~
	~~<br />~~

	===Tilemap===		===Tilemap===
	Tilemap or Gridmap can be used to build out the game world. Each uses a Tileset or MeshLibrary (respectively) to build their tiles.		Tilemap or Gridmap can be used to build out the game world. Each uses a Tileset or MeshLibrary (respectively) to build their tiles.
Line 52:		Line 43:
	<br />		<br />

	== Observations ==		==Observations==
	In Tux Builder, the main scene is the Master/Gameplay.gd. The UI is loaded with _load_node("res://Scenes/UI/LevelUI.tscn", "LevelUI"). Editor is similar.		In Tux Builder, the main scene is the Master/Gameplay.gd. The UI is loaded with _load_node("res://Scenes/UI/LevelUI.tscn", "LevelUI"). Editor is similar.

Leo at 04:52, 16 October 2020

2020-10-16T04:52:18Z

← Older revision		Revision as of 04:52, 16 October 2020
Line 23:		Line 23:
	Sprite nodes are drawn in the order that they are traversed on the SceneTree. Traversal is done depth-first (TODO: is this right?), meaning the first objects in the tree are drawn first. To switch the draw order, based on its Y position on the screen, use a YSort node (Huh. does this call sort every time something needs to draw? How do we deal with specific ordering otherwise?).		Sprite nodes are drawn in the order that they are traversed on the SceneTree. Traversal is done depth-first (TODO: is this right?), meaning the first objects in the tree are drawn first. To switch the draw order, based on its Y position on the screen, use a YSort node (Huh. does this call sort every time something needs to draw? How do we deal with specific ordering otherwise?).

	=== Physics ===		===Physics===
	The physics engine nodes are:		The physics engine nodes are:

	* <code>StaticBody</code> - Non-moving solid physical obstacle.		*<code>StaticBody</code> - Non-moving solid physical obstacle.
	* <code>RigidBody</code> - Moving physical object. Managed by engine.		*<code>RigidBody</code> - Moving physical object. Managed by engine.
	* <code>KinematicBody</code> - Moving physical object. Managed by you the coder.		*<code>KinematicBody</code> - Moving physical object. Managed by you the coder.
	* <code>Area</code> - Non-obstacle. Detects overlap with other physics bodies or areas.		*<code>Area</code> - Non-obstacle. Detects overlap with other physics bodies or areas.
	* <code>VehicleBody</code> - Simulate a moving vehicle with wheels. Includes drive and steering wheel functionality.		*<code>VehicleBody</code> - Simulate a moving vehicle with wheels. Includes drive and steering wheel functionality.
	* <code>RayCast</code> - Check along a directed line for any physics object; fast and effective check.		*<code>RayCast</code> - Check along a directed line for any physics object; fast and effective check.

	Objects belong to one collision layer but can collide with other objects in other layers by setting a collision mask. Objects that can collide can only be moved if they are a KinematicBody or if you manually change the position property of the object.		Objects belong to one collision layer but can collide with other objects in other layers by setting a collision mask. Objects that can collide can only be moved if they are a KinematicBody or if you manually change the position property of the object.
Line 42:		Line 42:
	or more layers. All physics objects specifies which collision layers apply to them.		or more layers. All physics objects specifies which collision layers apply to them.

	collision layers and ~~collsion~~ masks. The collision layer specifies which layer co		collision layers and collision masks. The collision layer specifies which layer co
	<br />		<br />

	=== Tilemap ===		===Tilemap===
	Tilemap or Gridmap can be used to build out the game world. Each uses a Tileset or MeshLibrary (respectively) to build their tiles.		Tilemap or Gridmap can be used to build out the game world. Each uses a Tileset or MeshLibrary (respectively) to build their tiles.

	Alternatively you could write your own.		Alternatively you could write your own.

			<br />

			== Observations ==
			In Tux Builder, the main scene is the Master/Gameplay.gd. The UI is loaded with _load_node("res://Scenes/UI/LevelUI.tscn", "LevelUI"). Editor is similar.

			Objects in the game are its own scene (tscn). The scene itself has _physics_process function that checks if it is affected by gravity, sets its velocity and direction to avoid out of bounds, or checks if it has reached a floor. It also checks if a player has collided with it. If he has, it plays a sound and stops its animation. The trampoline does more in a _on_Area2D_body_entered function which checks if the body is a player, enemy, or another trampoline. How a stack of trampolines interact with each other is handled here. The body that entered will have its velocity set.

	==Examples==		==Examples==
Line 69:		Line 76:
	}}		}}

	== Questions & Answers ==		==Questions & Answers==

	# How do we separate business logic from the presentation? It looks like we make models inherit <code>Sprite</code> so that they render so the MV (in MVC) is combined. How does this work if we want, say a 'headless' version of a game?		#How do we separate business logic from the presentation? It looks like we make models inherit <code>Sprite</code> so that they render so the MV (in MVC) is combined. How does this work if we want, say a 'headless' version of a game?
	#* I suspect that everything even when it inherits a Sprite is treated as a model. Godot then renders everything separately when needed. This removes the dependency on graphical stuff if it isn't needed.		#*I suspect that everything even when it inherits a Sprite is treated as a model. Godot then renders everything separately when needed. This removes the dependency on graphical stuff if it isn't needed.
	# sdf		#sdf

	==See Also==		==See Also==

	*https://github.com/br-n518/Godot-Beginners-Guide/blob/master/godot_guide.md		*https://github.com/br-n518/Godot-Beginners-Guide/blob/master/godot_guide.md

Leo at 04:10, 16 October 2020

2020-10-16T04:10:15Z

← Older revision		Revision as of 04:10, 16 October 2020
Line 1:		Line 1:
	== Concepts ==		==Concepts==

	=== File System ===		===File System===
	The filesystem that Godot provides is res:// for resources such as static game files or assets and user:// for dynamic data such as generated map data or game saves. Addons should be placed in res://addons in your project. Godot converts resource files into its own format and are placed in the res://.import folder.		The filesystem that Godot provides is res:// for resources such as static game files or assets and user:// for dynamic data such as generated map data or game saves. Addons should be placed in res://addons in your project. Godot converts resource files into its own format and are placed in the res://.import folder.

	=== Objects ===		===Objects===
	A ''Node'' is the building block of Godot; all scene objects in Godot are Nodes. Nodes have properties and functions and can emit signals which others can subscribe to. Nodes can be assigned as a child of another node and are arranged into a tree. A tree of nodes is referred to as a ''Scene''. Active scenes that are loaded and in use are part of a ''Scene Tree''. In addition to the hierarchy/inheritance model, nodes can also be organized by groups (eg. as groups of Enemies, Collectables, etc. which can be retrieved with <code>get_tree().get_nodes_in_group("enemies")</code>).		A ''Node'' is the building block of Godot; all scene objects in Godot are Nodes. Nodes have properties and functions and can emit signals which others can subscribe to. Nodes can be assigned as a child of another node and are arranged into a tree. A tree of nodes is referred to as a ''Scene''. Active scenes that are loaded and in use are part of a ''Scene Tree''. In addition to the hierarchy/inheritance model, nodes can also be organized by groups (eg. as groups of Enemies, Collectables, etc. which can be retrieved with <code>get_tree().get_nodes_in_group("enemies")</code>).

	A scene is saved to a TSCN (text-scene) file.		A scene is saved to a TSCN (text-scene) file.

	=== Scene Tree ===		===Scene Tree===
	Godot maintains an active set of scenes called a Scene Tree. When scenes are added to the scene tree, all its nodes will be added. Child nodes are added after their parent node. The root node of the Scene Tree is up to you but must be of a <code>Node2D</code> for 2D scenes or <code>Spatial</code> for 3D scenes.		Godot maintains an active set of scenes called a Scene Tree. When scenes are added to the scene tree, all its nodes will be added. Child nodes are added after their parent node. The root node of the Scene Tree is up to you but must be of a <code>Node2D</code> for 2D scenes or <code>Spatial</code> for 3D scenes.

Line 18:		Line 18:
	Nodes also receive a enter_tree notification. Only when all nodes have been added will they then be ready.		Nodes also receive a enter_tree notification. Only when all nodes have been added will they then be ready.

	==== 2D ====		====2D====
	(0, 0) is the top left.		(0, 0) is the top left.

	Sprite nodes are drawn in the order that they are traversed on the SceneTree. Traversal is done depth-first (TODO: is this right?), meaning the first objects in the tree are drawn first. To switch the draw order, based on its Y position on the screen, use a YSort node (Huh. does this call sort every time something needs to draw? How do we deal with specific ordering otherwise?).		Sprite nodes are drawn in the order that they are traversed on the SceneTree. Traversal is done depth-first (TODO: is this right?), meaning the first objects in the tree are drawn first. To switch the draw order, based on its Y position on the screen, use a YSort node (Huh. does this call sort every time something needs to draw? How do we deal with specific ordering otherwise?).

			=== Physics ===
			The physics engine nodes are:

			* <code>StaticBody</code> - Non-moving solid physical obstacle.
			* <code>RigidBody</code> - Moving physical object. Managed by engine.
			* <code>KinematicBody</code> - Moving physical object. Managed by you the coder.
			* <code>Area</code> - Non-obstacle. Detects overlap with other physics bodies or areas.
			* <code>VehicleBody</code> - Simulate a moving vehicle with wheels. Includes drive and steering wheel functionality.
			* <code>RayCast</code> - Check along a directed line for any physics object; fast and effective check.

			Objects belong to one collision layer but can collide with other objects in other layers by setting a collision mask. Objects that can collide can only be moved if they are a KinematicBody or if you manually change the position property of the object.



			Tween to make position changes transition smooth?


			or more layers. All physics objects specifies which collision layers apply to them.

			collision layers and collsion masks. The collision layer specifies which layer co
	<br />		<br />

	== Examples ==		=== Tilemap ===
			Tilemap or Gridmap can be used to build out the game world. Each uses a Tileset or MeshLibrary (respectively) to build their tiles.

			Alternatively you could write your own.

			==Examples==

	=== Node ===		===Node===
	Example of signals		Example of signals
	{{Highlight		{{Highlight
Line 43:		Line 69:
	}}		}}

	== See Also ==		== Questions & Answers ==

			# How do we separate business logic from the presentation? It looks like we make models inherit <code>Sprite</code> so that they render so the MV (in MVC) is combined. How does this work if we want, say a 'headless' version of a game?
			#* I suspect that everything even when it inherits a Sprite is treated as a model. Godot then renders everything separately when needed. This removes the dependency on graphical stuff if it isn't needed.
			# sdf

			==See Also==

	* https://github.com/br-n518/Godot-Beginners-Guide/blob/master/godot_guide.md		*https://github.com/br-n518/Godot-Beginners-Guide/blob/master/godot_guide.md

Leo: Created page with "== Concepts == === File System === The filesystem that Godot provides is res:// for resources such as static game files or assets and user:// for dynamic data such as generat..."

2020-10-16T03:54:49Z

Created page with "== Concepts == === File System === The filesystem that Godot provides is res:// for resources such as static game files or assets and user:// for dynamic data such as generat..."

New page

== Concepts ==

=== File System ===
The filesystem that Godot provides is res:// for resources such as static game files or assets and user:// for dynamic data such as generated map data or game saves. Addons should be placed in res://addons in your project. Godot converts resource files into its own format and are placed in the res://.import folder.

=== Objects ===
A ''Node'' is the building block of Godot; all scene objects in Godot are Nodes. Nodes have properties and functions and can emit signals which others can subscribe to. Nodes can be assigned as a child of another node and are arranged into a tree. A tree of nodes is referred to as a ''Scene''. Active scenes that are loaded and in use are part of a ''Scene Tree''. In addition to the hierarchy/inheritance model, nodes can also be organized by groups (eg. as groups of Enemies, Collectables, etc. which can be retrieved with <code>get_tree().get_nodes_in_group("enemies")</code>).

A scene is saved to a TSCN (text-scene) file.

=== Scene Tree ===
Godot maintains an active set of scenes called a Scene Tree. When scenes are added to the scene tree, all its nodes will be added. Child nodes are added after their parent node. The root node of the Scene Tree is up to you but must be of a <code>Node2D</code> for 2D scenes or <code>Spatial</code> for 3D scenes.

Control nodes are used for user interfaces and behave differently from Node2D. Controls should be placed in a separate tree, under a <code>CanvasLayer</code> node.

Code can get the SceneTree by calling <code>get_tree()</code>.

Nodes also receive a enter_tree notification. Only when all nodes have been added will they then be ready.

==== 2D ====
(0, 0) is the top left.

Sprite nodes are drawn in the order that they are traversed on the SceneTree. Traversal is done depth-first (TODO: is this right?), meaning the first objects in the tree are drawn first. To switch the draw order, based on its Y position on the screen, use a YSort node (Huh. does this call sort every time something needs to draw? How do we deal with specific ordering otherwise?).
<br />

== Examples ==

=== Node ===
Example of signals
{{Highlight
| code = extends Node2D

signal got_hurt (damage)

onready var hitpoints = 10 setget set_hitpoints

func set_hitpoints( new_hp ):
var diff = new_hp - hitpoints
if diff < 0:
emit_signal("got_hurt", diff)
hitpoints = new_hp
| lang = text
}}

== See Also ==

* https://github.com/br-n518/Godot-Beginners-Guide/blob/master/godot_guide.md