v2.2.0

Author: Ward727a

.gitignore

@@ -36,3 +36,4 @@ nv.file_system/
 test/test.tableCollection.res
 /datatable_backup
 /test
+/.vscode

addons/datatable_godot/class/class_datatable.gd

@@ -421,6 +421,7 @@ static func _convert_string_to_basis(value: String) -> Basis:
 
 # due to some unknown problem, the value after the dot (.0000) has some strange number added after it
 # Tried multiple thing on it, but found nothing to fix the problem
+# Found the reason, it's because of the binary representation of the float, so I need to round it to a certain number
 static func _convert_string_to_proj(value: String) -> Projection: 
 	var convert : String = value
 
@@ -722,7 +723,7 @@ func has_item(key: String)->bool:
 ## [br]
 ## Here is an example of what you could get from it:[br]
 ## [codeblock]{ "a_string": "little string", "float_object": 0.3241, ..., "vector3 object": (0.1, 1, -5) }[/codeblock]
-func get_item_as_dict(key: String)->Dictionary:
+func get_item(key: String)->Dictionary:
 
 	if !has_item(key):
 		var err = {"error":str("The table ",_table_name," doesn't contain the item '",key,"' key!")}
@@ -740,7 +741,11 @@ func get_item_as_dict(key: String)->Dictionary:
 
 	return rows[key]
 
-func get_item(key: String)->Structure:
+## Return the data of the item as a dictionary object.[br]
+## Emit: [signal item_getted] & [signal table_getted][br]
+## [br]
+## See [Structure] for more information about the global structure object, and check the generated class for more information about the specific object.
+func get_item_as_object(key: String)->Structure:
 
 	var struct_converted_name: String = _struct_name.replace(" ", "_")
 
@@ -750,8 +755,6 @@ func get_item(key: String)->Structure:
 		push_error("Can't return the item by the structure class, the structure_name is empty!")
 		return null
 
-	print(_dt_classDB.class_exist(className))
-	
 	if !_dt_classDB.class_exist(className):
 		push_error(str("Can't return the item by the structure class, the class of the structure (",className,") doesn't exist!\nYou need to create it or generate it first!"))
 		return null
@@ -766,7 +769,7 @@ func get_item(key: String)->Structure:
 		push_error(str("Can't return the item by the structure class, the class created is not valid!"))
 		return null
 
-	var _item = _classResource.new(get_item_as_dict(key))
+	var _item = _classResource.new(get_item(key))
 
 	if !_item:
 		push_error(str("Can't return the item created with the structure class, the item created is not valid, maybe an error with the data provided?"))
@@ -812,6 +815,13 @@ func add_item(item_key: String, item_data: Dictionary, save_data: bool = true)->
 
 	return true
 
+## Add an item inside the datatable[br]
+## Emit: [signal item_added] & [signal table_saved][br]
+## [br]
+## Be careful: All edit on the datatable will be saved inside the "datatable.res" if "save_data" arg is not on "false"!
+func add_item_as_object(item_key: String, item: Structure, save_data: bool = true)->bool:
+	return add_item(item_key, item._get_dict(_struct_data), save_data)
+
 ## Remove an item inside the datatable[br]
 ## Emit: [signal item_removed] & [signal table_saved][br]
 ## [br]
@@ -872,6 +882,13 @@ func set_item(item_key: String, item_data: Dictionary, save_data: bool = true)->
 
 	return true
 
+## Set an item inside the datatable[br]
+## Emit: [signal item_setted] & [signal table_saved][br]
+## [br]
+## Be careful: All edit on the datatable will be saved inside the "datatable.res" if "save_data" arg is not on "false"!
+func set_item_as_object(item_key: String, item: Structure, save_data: bool = true)->bool:
+	return set_item(item_key, item._get_dict(_struct_data), save_data)
+
 ## This function return you a dictionary that is pre-filled with the needed key for this table
 func get_void_item()->Dictionary:
 	var data = {}
@@ -912,11 +929,37 @@ func get_void_item()->Dictionary:
 
 	return data
 
+## This function return you a the compatible object for the table
+func get_void_item_as_object()->Structure:
+	var _class = _dt_classDB.class_instantiate("struct_"+_struct_name.replace(" ", "_"))
+
+	if !_class:
+		push_error(str("Can't create the void item as object, the class created is not valid!"))
+		return null
+	
+	if !_check_class(_class):
+		push_error(str("Can't create the void item as object, the class created is not valid!"))
+		return null
+	
+	return _class.new(get_void_item())
+
 ## Function to check if the given item is of the same structure as the table_name[br]
 ## [br]
 ## Return:[br]
 ## - True: The item can be added to the table[br]
-## - False: The item can't be added to the table
+## - False: The item can't be added to the table[br]
+## [br]
+## Args:[br]
+## - item: The item that need to be checked[br]
+## [br]
+## Example:[br]
+## [codeblock]
+## var item = {"name": "sword", "damage": 10, "durability": 100}
+## if datatable.is_item_compatible(item):
+##     print("The item is compatible with the table")
+## else:
+##     print("The item is not compatible with the table")
+## [/codeblock]
 func is_item_compatible(item: Dictionary)->bool:
 
 	if !_struct_data.has('params'):
@@ -931,11 +974,76 @@ func is_item_compatible(item: Dictionary)->bool:
 
 	return params.keys() == item.keys()
 
-## return all the KEY of items found in the table
+## Function to check if the given item is of the same structure as the table_name[br]
+## [br]
+## Return:[br]
+## - True: The item can be added to the table[br]
+## - False: The item can't be added to the table[br]
+## [br]
+## Args:[br]
+## - item: The item that need to be checked[br]
+## [br]
+## Example:[br]
+## We have a structure with the key "name", "damage" & "durability" named "items", we generated the class "struct_items" from it[br]
+## [codeblock]
+## var item = struct_items.new({"name": "sword", "damage": 10, "durability": 100})
+## if datatable.is_item_object_compatible(item):
+##     print("The item is compatible with the table")
+## else:
+##     print("The item is not compatible with the table")
+## [/codeblock]
+func is_item_object_compatible(item: Structure)->bool:
+	return is_item_compatible(item._get_dict(_struct_data))
+
+## return all the KEY of items found in the table[br]
+## Example: [br]
+## We have a table with the item "sword", "axe", "bow", and we want to get all the key inside this table[br]
+## [codeblock]
+## var keys = datatable.get_items_list()
+## print(keys) # ["sword", "axe", "bow"] - Will print all the key of the item in the table
+##
+## var swordValue = datatable.get_item("sword") # Get the item "sword" from the table
+## print(swordValue) # Will print the item "sword" value
+## [/codeblock]
 func get_items_list()->Array:
 
 	var rows = _get_table_rows()
 
 	return rows.keys()
 
+## Return the name of the rows of the table[br]
+## Example: [br]
+## We have a structure with the key "name", "damage" & "durability"[br]
+## We have a table with the item "sword", "axe", "bow", and we want to get all the key inside this table[br]
+## [codeblock]
+## var keys = datatable.get_keys_list()
+## print(keys) # ["name", "damage", "durability"] - Will print all the key of the structure used in the table
+## [/codeblock]
+func get_keys_list()->Array:
+	
+	var keys = []
+
+	for i in _struct_data['params']:
+		keys.append(i)
+	
+	return keys
+
+## Return all the values linked to the key, the key need to be one of the key of the structure[br]
+## Example: [br]
+## We have a structure with the key "name", "damage" & "durability"[br]
+## We have a table with the item "sword", "axe", "bow", and we want to get all the "name" key value[br]
+## [codeblock]
+## var names = datatable.get_value_of_key("name")
+## print(names) # ["sword", "axe", "bow"] - Will print all the name of all the item in the table
+## [/codeblock]
+func get_value_of_key(key: String):
+	
+	var rows = _get_table_rows()
+
+	var values = []
 
+	for i in rows:
+		if rows[i].has(key):
+			values.append(rows[i][key])
+	
+	return values

addons/datatable_godot/class/class_struct.gd

@@ -1,7 +1,28 @@
 extends Object
-## This class is for the DataTable Plugin, it's useless at the moment, I created it if I need it for the plugin in the futur
+## This class is for the DataTable Plugin pre-generated structure class code.
 ## [br]I discourage you to delete it, but do as you want!
 ##
 ## @experimental
 class_name Structure
 
+func _get_dict(_structure: Dictionary):
+
+    var _data: Dictionary = {}
+
+    for i in get_property_list():
+        if(i['name'].begins_with("_")):
+
+            var _name: String = i['name'].substr(1, i['name'].length() - 1)
+            var _var_name: String
+            
+            if _structure['params'].has(_name):
+                if i['type'] == TYPE_OBJECT:
+                    if get(i['name']) == null:
+                        _data[_name] = "res://"
+                    else:
+                        if get(i['name']).get_class() == "Resource":
+                                _data[_name] = get(i['name']).get_path()
+
+                    continue
+                _data[_name] = get(i['name'])
+    return _data

addons/datatable_godot/datatable.tscn

@@ -356,12 +356,12 @@ alignment = 2
 
 [node name="version_status" type="RichTextLabel" parent="MarginContainer/bg_main/Panel/VBoxContainer/HBoxContainer/HBoxContainer3"]
 layout_mode = 2
-tooltip_text = "The plugin is check for an update..."
+tooltip_text = "You good to go, you got the last version available!"
 mouse_default_cursor_shape = 2
 theme_override_styles/focus = SubResource("StyleBoxFlat_w7rfg")
 theme_override_styles/normal = SubResource("StyleBoxFlat_w7rfg")
 bbcode_enabled = true
-text = "[img]res://addons/datatable_godot/icons/Reload.png[/img] Checking for update... "
+text = "[img]res://addons/datatable_godot/icons/StatusSuccess.png[/img] [color=lightgreen]Version up-to-date! "
 fit_content = true
 autowrap_mode = 0
 script = ExtResource("7_76wdw")

addons/datatable_godot/plugin.cfg

@@ -2,7 +2,7 @@
 name="DataTable"
 description="A simple datatable system to use in godot"
 author="Ward"
-version="2.1.0"
+version="2.2.0"
 script="datatable.gd"
 
 [update]