Godot script example for deleting processes in Windows OS

A Godot example script that shows how you can terminate running programs from your Windows OS. This can be useful for things like multiplayer testing where you want to automatically terminate all spawned clients on some event such as startup.

Author: graydwarf

default_env.tres

@@ -0,0 +1,7 @@
+[gd_resource type="Environment" load_steps=2 format=2]
+
+[sub_resource type="ProceduralSky" id=1]
+
+[resource]
+background_mode = 2
+background_sky = SubResource( 1 )

icon.png

@@ -0,0 +1,34 @@
+[remap]
+
+importer="texture"
+type="StreamTexture"
+path="res://.import/icon.png-487276ed1e3a0c39cad0279d744ee560.stex"
+metadata={
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://icon.png"
+dest_files=[ "res://.import/icon.png-487276ed1e3a0c39cad0279d744ee560.stex" ]
+
+[params]
+
+compress/mode=0
+compress/lossy_quality=0.7
+compress/hdr_mode=0
+compress/bptc_ldr=0
+compress/normal_map=0
+flags/repeat=0
+flags/filter=true
+flags/mipmaps=false
+flags/anisotropic=false
+flags/srgb=2
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/HDR_as_SRGB=false
+process/invert_color=false
+stream=false
+size_limit=0
+detect_3d=true
+svg/scale=1.0

icon.png.import

@@ -0,0 +1,41 @@
+extends Node2D
+
+onready var _endTaskButton = $EndTaskButton
+onready var _taskNameLineEdit = $TaskNameLineEdit
+
+func _ready() -> void:
+	pass
+
+# Finds all tasks with the specified image name
+# which is the executable name as it shows up in task manager.
+func TerminateProcess(taskName):
+	var output = []
+	var error = OS.execute("tasklist", ["/fi", "imagename eq " + taskName, "/fo", "csv"], true, output)
+	if error == 1:
+		print("Failed to execute tasklist command!")
+		return
+
+	var taskListData : Array = output[0].split("\n", false)
+
+	# Remove the headers
+	taskListData.remove(0)
+
+	if taskListData.empty():
+		print("Did not find a matching task to terminate.")
+		return
+
+	for line in taskListData:
+		var data = line.split(",")
+		var pid = data[1]
+		error = OS.execute("taskkill", ["/f", "/pid", pid], true)
+		if error == 1:
+			print("Failed to end task to pid: " + pid)
+		else:
+			print("Successfully ended task to pid: " + pid)
+
+func _on_Button_pressed() -> void:
+	if _taskNameLineEdit.text == "":
+		OS.alert("Yo! Need to provide a task name first!")
+		return
+
+	TerminateProcess(_taskNameLineEdit.text)

main.gd

@@ -0,0 +1,53 @@
+[gd_scene load_steps=2 format=2]
+
+[ext_resource path="res://main.gd" type="Script" id=1]
+
+[node name="Main" type="Node2D"]
+script = ExtResource( 1 )
+
+[node name="TaskNameLabel" type="Label" parent="."]
+margin_left = 27.0
+margin_top = 279.0
+margin_right = 101.0
+margin_bottom = 293.0
+text = "Task Name:"
+__meta__ = {
+"_edit_use_anchors_": false
+}
+
+[node name="EndTaskButton" type="Button" parent="."]
+margin_left = 311.0
+margin_top = 274.0
+margin_right = 418.0
+margin_bottom = 297.0
+text = "End Task"
+__meta__ = {
+"_edit_use_anchors_": false
+}
+
+[node name="TaskNameLineEdit" type="LineEdit" parent="."]
+margin_left = 103.0
+margin_top = 274.0
+margin_right = 306.0
+margin_bottom = 298.0
+__meta__ = {
+"_edit_use_anchors_": false
+}
+
+[node name="WarningLabel" type="Label" parent="."]
+margin_left = 25.0
+margin_top = 27.0
+margin_right = 648.0
+margin_bottom = 228.0
+text = "WARNING! Please review the code and make sure it's going to work as expected for your specific  environment. I make no promises in regards to the integrity and behavior of this code. Loss of data is possible if you end task to the wrong thing. Recommend stepping through all the code (including error handling) to make sure it's doing what you want.
+
+For demo purposes, specify a taskname and click the EndTask button to terminate ALL processes with that name. 
+
+A simple test scenario is to launch and terminate one or more notepad.exe processes. Make sure to save and close any that are already open first! Do specify the file extension in the Task Name field as well. Example: notepad.exe
+
+Some errors output to the debug console so check there if nothing happens."
+autowrap = true
+__meta__ = {
+"_edit_use_anchors_": false
+}
+[connection signal="pressed" from="EndTaskButton" to="." method="_on_Button_pressed"]

main.tscn

@@ -0,0 +1,24 @@
+; Engine configuration file.
+; It's best edited using the editor UI and not directly,
+; since the parameters that go here are not all obvious.
+;
+; Format:
+;   [section] ; section goes between []
+;   param=value ; assign values to parameters
+
+config_version=4
+
+_global_script_classes=[  ]
+_global_script_class_icons={
+
+}
+
+[application]
+
+config/name="godot-script-endtask"
+run/main_scene="res://main.tscn"
+config/icon="res://icon.png"
+
+[rendering]
+
+environment/default_environment="res://default_env.tres"