added folder api

Author: Roberto De Ioris

Source/UnrealEnginePython/Private/UEPyModule.cpp

@@ -621,6 +621,14 @@ static PyMethodDef ue_PyUObject_methods[] = {
 	{ "set_actor_label", (PyCFunction)py_ue_set_actor_label, METH_VARARGS, "" },
 	{ "set_actor_hidden_in_game", (PyCFunction)py_ue_set_actor_hidden_in_game, METH_VARARGS, "" },
 
+	{ "get_folder_path", (PyCFunction)py_ue_get_folder_path, METH_VARARGS, "" },
+	{ "set_folder_path", (PyCFunction)py_ue_set_folder_path, METH_VARARGS, "" },
+
+	{ "world_create_folder", (PyCFunction)py_ue_world_create_folder, METH_VARARGS, "" },
+	{ "world_delete_folder", (PyCFunction)py_ue_world_delete_folder, METH_VARARGS, "" },
+	{ "world_rename_folder", (PyCFunction)py_ue_world_rename_folder, METH_VARARGS, "" },
+	{ "world_folders", (PyCFunction)py_ue_world_folders, METH_VARARGS, "" },
+
 	{ "get_editor_world_counterpart_actor", (PyCFunction)py_ue_get_editor_world_counterpart_actor, METH_VARARGS, "" },
 	{ "component_type_registry_invalidate_class", (PyCFunction)py_ue_component_type_registry_invalidate_class, METH_VARARGS, "" },
 

Source/UnrealEnginePython/Private/UObject/UEPyActor.cpp

@@ -221,6 +221,49 @@ PyObject *py_ue_component_type_registry_invalidate_class(ue_PyUObject *self, PyO
 	Py_RETURN_NONE;
 }
 
+PyObject *py_ue_get_folder_path(ue_PyUObject *self, PyObject * args)
+{
+
+	ue_py_check(self);
+
+	AActor *actor = ue_py_check_type<AActor>(self);
+	if (!actor)
+		return PyErr_Format(PyExc_Exception, "uobject is not an actor");
+
+	const FName DirPath = actor->GetFolderPath();
+
+	return PyUnicode_FromString(TCHAR_TO_UTF8(*DirPath.ToString()));
+}
+
+PyObject *py_ue_set_folder_path(ue_PyUObject *self, PyObject * args)
+{
+
+	ue_py_check(self);
+
+	char *path;
+	PyObject *py_bool = nullptr;
+
+	if (!PyArg_ParseTuple(args, "s|O:set_folder_path", &path, &py_bool))
+		return nullptr;
+
+	AActor *actor = ue_py_check_type<AActor>(self);
+	if (!actor)
+		return PyErr_Format(PyExc_Exception, "uobject is not an actor");
+
+	FName DirPath = FName(UTF8_TO_TCHAR(path));
+
+	if (py_bool && PyObject_IsTrue(py_bool))
+	{
+		actor->SetFolderPath_Recursively(DirPath);
+	}
+	else
+	{
+		actor->SetFolderPath(DirPath);
+	}
+
+	Py_RETURN_NONE;
+}
+
 PyObject *py_ue_get_actor_label(ue_PyUObject *self, PyObject * args)
 {
 
@@ -285,7 +328,7 @@ PyObject *py_ue_set_actor_hidden_in_game(ue_PyUObject *self, PyObject * args)
 		actor->SetActorHiddenInGame(false);
 	}
 
-	
+
 
 	Py_RETURN_NONE;
 }

Source/UnrealEnginePython/Private/UObject/UEPyActor.h

@@ -27,6 +27,8 @@ PyObject *py_ue_actor_set_level_sequence(ue_PyUObject *, PyObject *);
 #if WITH_EDITOR
 PyObject *py_ue_get_actor_label(ue_PyUObject *, PyObject *);
 PyObject *py_ue_set_actor_label(ue_PyUObject *, PyObject *);
+PyObject *py_ue_get_folder_path(ue_PyUObject *, PyObject *);
+PyObject *py_ue_set_folder_path(ue_PyUObject *, PyObject *);
 PyObject *py_ue_set_actor_hidden_in_game(ue_PyUObject *, PyObject *);
 PyObject *py_ue_find_actor_by_label(ue_PyUObject *, PyObject *);
 PyObject *py_ue_get_editor_world_counterpart_actor(ue_PyUObject *, PyObject *);

Source/UnrealEnginePython/Private/UObject/UEPyWorld.cpp

@@ -4,6 +4,9 @@
 #include "EngineUtils.h"
 #include "Kismet/GameplayStatics.h"
 #include "Runtime/CoreUObject/Public/UObject/UObjectIterator.h"
+#if WITH_EDITOR
+#include "Editor/UnrealEd/Public/EditorActorFolders.h"
+#endif
 
 PyObject *py_ue_world_exec(ue_PyUObject *self, PyObject * args)
 {
@@ -315,3 +318,105 @@ PyObject *py_ue_set_current_level(ue_PyUObject *self, PyObject * args)
 	Py_RETURN_FALSE;
 }
 
+#if WITH_EDITOR
+PyObject *py_ue_world_create_folder(ue_PyUObject *self, PyObject * args)
+{
+
+	ue_py_check(self);
+
+	char *path;
+	if (!PyArg_ParseTuple(args, "s:world_create_folder", &path))
+		return nullptr;
+
+	if (!FActorFolders::IsAvailable())
+		return PyErr_Format(PyExc_Exception, "FActorFolders is not available");
+
+	UWorld *world = ue_get_uworld(self);
+	if (!world)
+		return PyErr_Format(PyExc_Exception, "unable to retrieve UWorld from uobject");
+
+	FName FolderPath = FName(UTF8_TO_TCHAR(path));
+
+	FActorFolders::Get().CreateFolder(*world, FolderPath);
+
+	Py_RETURN_NONE;
+}
+
+PyObject *py_ue_world_delete_folder(ue_PyUObject *self, PyObject * args)
+{
+
+	ue_py_check(self);
+
+	char *path;
+	if (!PyArg_ParseTuple(args, "s:world_delete_folder", &path))
+		return nullptr;
+
+	if (!FActorFolders::IsAvailable())
+		return PyErr_Format(PyExc_Exception, "FActorFolders is not available");
+
+	UWorld *world = ue_get_uworld(self);
+	if (!world)
+		return PyErr_Format(PyExc_Exception, "unable to retrieve UWorld from uobject");
+
+	FName FolderPath = FName(UTF8_TO_TCHAR(path));
+
+	FActorFolders::Get().DeleteFolder(*world, FolderPath);
+
+	Py_RETURN_NONE;
+}
+
+PyObject *py_ue_world_rename_folder(ue_PyUObject *self, PyObject * args)
+{
+
+	ue_py_check(self);
+
+	char *path;
+	char *new_path;
+	if (!PyArg_ParseTuple(args, "ss:world_rename_folder", &path, &new_path))
+		return nullptr;
+
+	if (!FActorFolders::IsAvailable())
+		return PyErr_Format(PyExc_Exception, "FActorFolders is not available");
+
+	UWorld *world = ue_get_uworld(self);
+	if (!world)
+		return PyErr_Format(PyExc_Exception, "unable to retrieve UWorld from uobject");
+
+	FName FolderPath = FName(UTF8_TO_TCHAR(path));
+	FName NewFolderPath = FName(UTF8_TO_TCHAR(new_path));
+
+	if (FActorFolders::Get().RenameFolderInWorld(*world, FolderPath, NewFolderPath))
+		Py_RETURN_TRUE;
+
+	Py_RETURN_FALSE;
+}
+
+PyObject *py_ue_world_folders(ue_PyUObject *self, PyObject * args)
+{
+
+	ue_py_check(self);
+
+	if (!FActorFolders::IsAvailable())
+		return PyErr_Format(PyExc_Exception, "FActorFolders is not available");
+
+	UWorld *world = ue_get_uworld(self);
+	if (!world)
+		return PyErr_Format(PyExc_Exception, "unable to retrieve UWorld from uobject");
+
+	const TMap<FName, FActorFolderProps> &Folders = FActorFolders::Get().GetFolderPropertiesForWorld(*world);
+
+	PyObject *py_list = PyList_New(0);
+
+	TArray<FName> FolderNames;
+	Folders.GenerateKeyArray(FolderNames);
+	
+	for (FName FolderName : FolderNames)
+	{
+		PyObject *py_str = PyUnicode_FromString(TCHAR_TO_UTF8(*FolderName.ToString()));
+		PyList_Append(py_list, py_str);
+		Py_DECREF(py_str);
+	}
+
+	return py_list;
+}
+#endif

Source/UnrealEnginePython/Private/UObject/UEPyWorld.h

@@ -30,3 +30,10 @@ PyObject *py_ue_set_current_level(ue_PyUObject *, PyObject *);
 
 PyObject *py_ue_get_world_type(ue_PyUObject *, PyObject *);
 
+#if WITH_EDITOR
+PyObject *py_ue_world_create_folder(ue_PyUObject *, PyObject *);
+PyObject *py_ue_world_delete_folder(ue_PyUObject *, PyObject *);
+PyObject *py_ue_world_rename_folder(ue_PyUObject *, PyObject *);
+PyObject *py_ue_world_folders(ue_PyUObject *, PyObject *);
+#endif
+

examples/world_folders_and_groups.py

@@ -0,0 +1,26 @@
+import unreal_engine as ue
+from unreal_engine.classes import GroupActor
+
+import time
+
+world = ue.get_editor_world()
+group_actor = world.actor_spawn(GroupActor)
+
+for folder in world.world_folders():
+    print(folder)
+
+new_folder = 'FooBar_{}'.format(int(time.time()))
+
+world.world_create_folder(new_folder)
+
+world.world_rename_folder(new_folder, new_folder + '__hello')
+
+world.world_delete_folder(new_folder + '__hello')
+
+actor = ue.editor_get_selected_actors()[0]
+
+# folder tree will be automatically created
+actor.set_folder_path('Test1/Test2/Test3')
+
+# assign actors to the group
+group_actor.GroupActors = [actor]