Skip to content

SimpleSpawner: Rename frequency to period #272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 23, 2024
Merged

SimpleSpawner: Rename frequency to period #272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06f325c
SimpleSpawner: Add unit suffixes to exported properties
wjt Oct 14, 2024
a353af4
SimpleSpawner: Rename frequency to period
wjt Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions addons/block_code/examples/spawner/spawner.tscn
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ arguments = {

[sub_resource type="Resource" id="Resource_uv0fo"]
script = ExtResource("7_cykhe")
name = &"simplespawner_get_spawn_frequency"
name = &"simplespawner_get_spawn_period"
arguments = {}

[sub_resource type="Resource" id="Resource_l45hk"]
Expand All @@ -50,10 +50,10 @@ arguments = {

[sub_resource type="Resource" id="Resource_6g0ng"]
script = ExtResource("6_dv2kl")
name = &"simplespawner_set_spawn_frequency"
name = &"simplespawner_set_spawn_period"
children = Array[ExtResource("6_dv2kl")]([])
arguments = {
"new_frequency": SubResource("Resource_l45hk")
"new_period": SubResource("Resource_l45hk")
}

[sub_resource type="Resource" id="Resource_ke4bk"]
Expand All @@ -74,7 +74,7 @@ arguments = {

[sub_resource type="Resource" id="Resource_ih8lj"]
script = ExtResource("7_cykhe")
name = &"simplespawner_get_spawn_frequency"
name = &"simplespawner_get_spawn_period"
arguments = {}

[sub_resource type="Resource" id="Resource_rfxul"]
Expand All @@ -87,10 +87,10 @@ arguments = {

[sub_resource type="Resource" id="Resource_2rqfa"]
script = ExtResource("6_dv2kl")
name = &"simplespawner_set_spawn_frequency"
name = &"simplespawner_set_spawn_period"
children = Array[ExtResource("6_dv2kl")]([])
arguments = {
"new_frequency": SubResource("Resource_rfxul")
"new_period": SubResource("Resource_rfxul")
}

[sub_resource type="Resource" id="Resource_movu5"]
Expand Down Expand Up @@ -194,9 +194,9 @@ func _ready():

func _process(delta):
if (Input.is_action_just_pressed('ui_right')):
do_set_spawn_frequency(((spawn_frequency) - 0.1))
spawn_period = ((spawn_period) - 0.1)
elif (Input.is_action_just_pressed('ui_left')):
do_set_spawn_frequency(((spawn_frequency) + 0.1))
spawn_period = ((spawn_period) + 0.1)
elif (Input.is_action_just_pressed('ui_up')):
if (is_spawning()):
spawn_stop()
Expand All @@ -216,7 +216,7 @@ version = 0
position = Vector2(103, 128)
script = ExtResource("1_g2l2s")
scenes = Array[PackedScene]([ExtResource("2_d0h86"), ExtResource("3_tt12o")])
spawn_frequency = 0.6
spawn_period = 0.6
spawn_limit = 5

[node name="BlockCode" type="Node" parent="SimpleSpawner"]
Expand Down
32 changes: 14 additions & 18 deletions addons/block_code/simple_spawner/simple_spawner.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ enum LimitBehavior { REPLACE, NO_SPAWN }

## The period of time in seconds to spawn another component. If zero, they won't spawn
## automatically. Use the "Spawn" block.
@export_range(0.0, 10.0, 0.1, "or_greater") var spawn_frequency: float = 0.0:
set = _set_spawn_fraquency
@export_range(0.0, 10.0, 0.1, "or_greater", "suffix:s") var spawn_period: float = 0.0:
set = _set_spawn_period

## How many spawned scenes are allowed. If zero, there is no limit.
@export_range(0, 50, 0.1, "or_greater") var spawn_limit: int = 50
@export_range(0, 50, 0.1, "or_greater", "suffix:scenes") var spawn_limit: int = 50

## What happens when the limit is reached and a new spawn is attempted:
## - Replace: Remove the oldest spawned scene and spawn a new one.
Expand All @@ -53,20 +53,20 @@ func _remove_oldest_spawned():
spawned.get_parent().remove_child(spawned)


func _set_spawn_fraquency(new_frequency: float):
spawn_frequency = new_frequency
func _set_spawn_period(new_period: float):
spawn_period = new_period
if not _timer or not is_instance_valid(_timer):
return
_timer.wait_time = spawn_frequency
_timer.wait_time = spawn_period


func spawn_start():
if spawn_frequency == 0.0:
if spawn_period == 0.0:
return
if not _timer or not is_instance_valid(_timer):
_timer = Timer.new()
add_child(_timer)
_timer.wait_time = spawn_frequency
_timer.wait_time = spawn_period
_timer.timeout.connect(spawn_once)
_timer.start()
spawn_once.call_deferred()
Expand Down Expand Up @@ -107,10 +107,6 @@ func spawn_once():
spawned.position = global_position


func do_set_spawn_frequency(new_frequency: float):
_set_spawn_fraquency(new_frequency)


static func setup_custom_blocks():
var _class_name = "SimpleSpawner"
var block_list: Array[BlockDefinition] = []
Expand Down Expand Up @@ -153,22 +149,22 @@ static func setup_custom_blocks():
block_list.append(block_definition)

block_definition = BlockDefinition.new()
block_definition.name = &"simplespawner_set_spawn_frequency"
block_definition.name = &"simplespawner_set_spawn_period"
block_definition.target_node_class = _class_name
block_definition.category = "Lifecycle | Spawn"
block_definition.type = Types.BlockType.STATEMENT
block_definition.display_template = "set spawn frequency to {new_frequency: FLOAT}"
block_definition.code_template = "do_set_spawn_frequency({new_frequency})"
block_definition.display_template = "set spawn period to {new_period: FLOAT}"
block_definition.code_template = "spawn_period = {new_period}"
block_list.append(block_definition)

block_definition = BlockDefinition.new()
block_definition.name = &"simplespawner_get_spawn_frequency"
block_definition.name = &"simplespawner_get_spawn_period"
block_definition.target_node_class = _class_name
block_definition.category = "Lifecycle | Spawn"
block_definition.type = Types.BlockType.VALUE
block_definition.variant_type = TYPE_FLOAT
block_definition.display_template = "spawn frequency"
block_definition.code_template = "spawn_frequency"
block_definition.display_template = "spawn period"
block_definition.code_template = "spawn_period"
block_list.append(block_definition)

BlocksCatalog.add_custom_blocks(_class_name, block_list, [], {})