Better format and static type Fade (#785)

Author: mubinulhaque

addons/godot-xr-tools/effects/fade.gd

@@ -2,36 +2,52 @@
 class_name XRToolsFade
 extends Node3D
 
-
 ## XR Tools Fade Script
 ##
 ## This script manages fading the view.
 
-@export_flags_3d_render var layers = 2:
+@export_flags_3d_render var layers: int = 2:
 	set(value):
 		layers = value
 		if _mesh:
 			_mesh.layers = layers
 
+
 # Dictionary of fade requests
-var _faders : Dictionary = {}
+var _faders: Dictionary[Variant, Color] = {}
 
 # Fade update flag
-var _update : bool = false
+var _update: bool = false
 
 # Fade mesh
-var _mesh : MeshInstance3D
+var _mesh: MeshInstance3D
 
 # Fade shader material
-var _material : ShaderMaterial
+var _material: ShaderMaterial
 
 
-# Add support for is_xr_class on XRTools classes
-func is_xr_class(xr_name:  String) -> bool:
-	return xr_name == "XRToolsFade"
+## Returns our first current fade node
+static func get_fade_node() -> XRToolsFade:
+	# In the future this use of groups should be replaced by static instances.
+	var tree := Engine.get_main_loop() as SceneTree
+	for node in tree.get_nodes_in_group("fade_mesh"):
+		var fade := node as XRToolsFade
+		if fade:
+			return fade
+
+	return null
+
+
+## Set the fade level on the fade instance
+static func set_fade(p_whom: Variant, p_color: Color) -> void:
+	# In the future this use of groups should be replaced by static instances.
+	var tree := Engine.get_main_loop() as SceneTree
+	for node in tree.get_nodes_in_group("fade_mesh"):
+		var fade := node as XRToolsFade
+		if fade:
+			fade.set_fade_level(p_whom, p_color)
 
 
-# Called when the fade node is ready
 func _ready() -> void:
 	# Add to the fade_mesh group - in the future this should be replaced with
 	# static instances.
@@ -44,15 +60,15 @@ func _ready() -> void:
 		_material = _mesh.get_surface_override_material(0)
 
 
-# Called every frame. 'delta' is the elapsed time since the previous frame.
-func _process(_delta : float) -> void:
+func _process(_delta: float) -> void:
 	# Skip if nothing to update
 	if not _update:
 		return
 
 	# Calculate the cumulative shade color
 	var fade := Color(1, 1, 1, 0)
 	var show := false
+
 	for whom in _faders:
 		var color := _faders[whom] as Color
 		fade = fade.blend(color)
@@ -64,8 +80,13 @@ func _process(_delta : float) -> void:
 	_update = false
 
 
-# Set the fade level
-func set_fade_level(p_whom : Variant, p_color : Color) -> void:
+## Add support for is_xr_class on XRTools classes
+func is_xr_class(xr_name: String) -> bool:
+	return xr_name == "XRToolsFade"
+
+
+## Set the fade level
+func set_fade_level(p_whom: Variant, p_color: Color) -> void:
 	# Test if fading is needed
 	if p_color.a > 0:
 		# Set the fade level
@@ -74,24 +95,3 @@ func set_fade_level(p_whom : Variant, p_color : Color) -> void:
 	elif _faders.erase(p_whom):
 		# Fade erased
 		_update = true
-
-
-## Returns our first current fade node
-static func get_fade_node() -> XRToolsFade:
-	# In the future this use of groups should be replaced by static instances.
-	var tree := Engine.get_main_loop() as SceneTree
-	for node in tree.get_nodes_in_group("fade_mesh"):
-		var fade := node as XRToolsFade
-		if fade:
-			return fade
-
-	return null
-
-## Set the fade level on the fade instance
-static func set_fade(p_whom : Variant, p_color : Color) -> void:
-	# In the future this use of groups should be replaced by static instances.
-	var tree := Engine.get_main_loop() as SceneTree
-	for node in tree.get_nodes_in_group("fade_mesh"):
-		var fade := node as XRToolsFade
-		if fade:
-			fade.set_fade_level(p_whom, p_color)

addons/godot-xr-tools/effects/fade.tscn

@@ -14,9 +14,9 @@ shader_parameter/albedo = Color(0, 0, 0, 1)
 
 [node name="Fade" type="Node3D"]
 script = ExtResource("1_6667f")
-cull_mask = 1
 
 [node name="FadeMesh" type="MeshInstance3D" parent="."]
 visible = false
+layers = 2
 mesh = SubResource("QuadMesh_aqp6r")
 surface_material_override/0 = SubResource("ShaderMaterial_xjgy8")