Added Several snippets & updated existing ones

Author: ManasMakde

_jsx/global.jsx

@@ -30,7 +30,7 @@ let GuideGenerationCount = 0  // Keeps count of guide generation, deletes old gu
 // URLS
 export const UE_ABSOLUTE_INCLUDE_PATH_URL = "/snippets/unreal-engine/ue-allow-include-path-be-absolute/"
 export const UE_CREATING_NEW_OBJECT_URL = "/snippets/unreal-engine-5-cpp/ue-creating-new-objects/"
-export const UE_EDIT_OBJECT_IN_EDITOR_URL = "/snippets/unreal-engine-5-cpp/ue-edit-custom-object-in-editor/"
+export const UE_EDIT_OBJECT_IN_EDITOR_URL = "/snippets/unreal-engine-5-cpp/ue-create-custom-reusable-objects/"
 export const UOBJECT_BLUEPRINT_VARIABLE_DETAILS_PANEL_URL = "https://forums.unrealengine.com/t/uobject-as-blueprint-variable-with-details-panel/445256"
 
 

snippets/unreal-engine-5-cpp/ue-boilerplate-ublueprintfunctionlibrary/index.mdx

@@ -0,0 +1,38 @@
+import { HTMLSkeleton, H1 } from "./_jsx/global.jsx"
+
+export const snippet_title = "Boilerplate UBlueprintFunctionLibrary in Unreal Engine 5 C++"
+export const snippet_category = "Unreal Engine 5 C++"
+
+<HTMLSkeleton RegisterToSiteGuide={{ category : snippet_category, title : snippet_title }}>
+
+<H1>{snippet_title}</H1>
+
+```cpp
+// MyBlueprintFunctionLibrary.h file
+
+#pragma once
+
+#include "CoreMinimal.h"
+#include "Kismet/BlueprintFunctionLibrary.h"
+#include "MyBlueprintFunctionLibrary.generated.h"
+
+/**
+ * 
+ */
+UCLASS()
+class TESTING_API UMyBlueprintFunctionLibrary : public UBlueprintFunctionLibrary
+{
+	GENERATED_BODY()
+	
+};
+
+```
+
+
+```cpp
+// MyBlueprintFunctionLibrary.cpp file
+
+#include "MyBlueprintFunctionLibrary.h"
+
+```
+</HTMLSkeleton>

snippets/unreal-engine-5-cpp/ue-boilerplate-uobject/index.mdx

@@ -1,4 +1,4 @@
-import { HTMLSkeleton, H1 } from "./_jsx/global.jsx"
+import { HTMLSkeleton, H1, UE_EDIT_OBJECT_IN_EDITOR_URL } from "./_jsx/global.jsx"
 
 export const snippet_title = "Boilerplate UObject in Unreal Engine 5 C++"
 export const snippet_category = "Unreal Engine 5 C++"
@@ -7,6 +7,8 @@ export const snippet_category = "Unreal Engine 5 C++"
 
 <H1>{snippet_title}</H1>
 
+**Note:** For how to _PROPERLY_ create a custom object check <a href={UE_EDIT_OBJECT_IN_EDITOR_URL}>here</a>
+
 ```cpp
 // MyObject.h file
 
@@ -30,4 +32,5 @@ class TESTING_API UMyObject : public UObject
 
 #include "MyObject.h"
 ```
+
 </HTMLSkeleton>

snippets/unreal-engine-5-cpp/ue-check-running-in-editor/index.mdx

@@ -0,0 +1,20 @@
+import { HTMLSkeleton, H1, UE_EDIT_OBJECT_IN_EDITOR_URL } from "./_jsx/global.jsx"
+
+export const snippet_title = "Check if running in editor in Unreal Engine 5 C++"
+export const snippet_category = "Unreal Engine 5 C++"
+
+<HTMLSkeleton RegisterToSiteGuide={{ category : snippet_category, title : snippet_title }}>
+
+<H1>{snippet_title}</H1>
+
+This will work on all `UObject` derived classes
+
+```cpp
+if (UWorld* World = GetWorld()) {
+    if (World->WorldType == EWorldType::Editor || World->WorldType == EWorldType::EditorPreview) {
+        return;
+    }
+}
+```
+
+</HTMLSkeleton>

snippets/unreal-engine-5-cpp/ue-edit-custom-object-in-editor/index.mdx renamed to snippets/unreal-engine-5-cpp/ue-create-custom-reusable-objects/index.mdx

@@ -1,6 +1,6 @@
 import { HTMLSkeleton, H1, UOBJECT_BLUEPRINT_VARIABLE_DETAILS_PANEL_URL } from "./_jsx/global.jsx"
 
-export const snippet_title = "Edit Custom Object in Editor in Unreal Engine 5 C++"
+export const snippet_title = "Create custom reusable Objects in Unreal Engine 5 C++"
 export const snippet_category = "Unreal Engine 5 C++"
 
 <HTMLSkeleton RegisterToSiteGuide={{ category : snippet_category, title : snippet_title }}>
@@ -9,7 +9,7 @@ export const snippet_category = "Unreal Engine 5 C++"
 
 ```cpp
 // MyObject.h
-UCLASS(DefaultToInstanced, EditInlineNew, Blueprintable) // Add DefaultToInstanced & EditInlineNew
+UCLASS(DefaultToInstanced, EditInlineNew, Blueprintable) // Do NOT forget to add `DefaultToInstanced` & `EditInlineNew`
 class TESTING_API UMyObject : public UObject {
 
     GENERATED_BODY()

snippets/unreal-engine-5-cpp/ue-invoke-ufunction-processevent/index.mdx

@@ -0,0 +1,57 @@
+import { HTMLSkeleton, H1 } from "./_jsx/global.jsx"
+
+export const snippet_title = "Invoking UFunction by name via ProcessEvent in Unreal Engine 5 C++"
+export const snippet_category = "Unreal Engine 5 C++"
+
+<HTMLSkeleton RegisterToSiteGuide={{ category : snippet_category, title : snippet_title }}>
+
+<H1 WrittenOn={new Date("2024-07-27")}>{snippet_title}</H1>
+
+Example Class:
+```cpp
+UCLASS()
+class TESTING_API UMyObject : public UObject {
+    GENERATED_BODY()
+
+   public:
+    UFUNCTION()
+    void MyMethod(){ UE_LOG(LogTemp, Warning, TEXT("MyMethod Invoked")); }
+
+    UFUNCTION()
+    void MyMethodArgs(int32 Value){ UE_LOG(LogTemp, Warning, TEXT("MyMethodArgs called with = %d"), Value); }
+};
+```
+
+<br/>
+
+Invoking UFunction:
+
+```cpp
+// Creating Object
+UMyObject* MyObj = NewObject<UMyObject>(this, TEXT("MyObject"));
+
+
+
+// Invoking function without arguments
+FName MethodName = FName(TEXT("MyMethod"));
+UFunction* Func = MyObj->FindFunction(MethodName);
+if (Func) {
+    MyObj->ProcessEvent(Func, nullptr);
+}
+
+
+
+// Invoking function with arguments
+FName MethodArgsName = FName(TEXT("MyMethodArgs"));
+UFunction* FuncArgs = MyObj->FindFunction(MethodArgsName);
+if (FuncArgs) {
+    struct
+    {
+        int32 Value;
+    } ParamStruct;
+    ParamStruct.Value = 56;
+
+    MyObj->ProcessEvent(FuncArgs, &ParamStruct);
+}
+```
+</HTMLSkeleton>

snippets/unreal-engine-5-cpp/ue-printing-logging/index.mdx

@@ -7,70 +7,94 @@ export const snippet_category = "Unreal Engine 5 C++"
 
 <H1>{snippet_title}</H1>
 
+
+## Syntax
 ```cpp
 // Writing On Screen
 if(GEngine)
-    GEngine->AddOnScreenDebugMessage(-1, 10.0f, FColor::Red, TEXT("Some message"));   
+    GEngine->AddOnScreenDebugMessage(-1, 10.0f, FColor::Red, TEXT("Message"));   
 
 
 // Writting in Output Log 
-UE_LOG(LogTemp, Warning, TEXT("Some message"));
-
+UE_LOG(LogTemp, Warning, TEXT("Message"));
+```
 
+<br/>
 
-// print int
+## Default datatypes
+```cpp
+// int
 int MyInt = 3;
 GEngine->AddOnScreenDebugMessage(-1, 10.0f, FColor::Red, FString::Printf(TEXT("int: %d"), MyInt));
 UE_LOG(LogTemp, Warning, TEXT("int: %d"), MyInt);
 
 
 
-// print float
+// float
 float MyFloat = 10.5f;
 GEngine->AddOnScreenDebugMessage(-1, 10.0f, FColor::Red, FString::Printf(TEXT("float: %f"), MyFloat));
 UE_LOG(LogTemp, Warning, TEXT("float: %f"), MyFloat);
 
 
 
-// print boolean
+// boolean
 bool bMyBool = true;
 GEngine->AddOnScreenDebugMessage(-1, 10.0f, FColor::Red, FString::Printf(TEXT("bool: %s"), bMyBool ? TEXT("true") : TEXT("false")));
 UE_LOG(LogTemp, Warning, TEXT("bool: %s"), bMyBool ? TEXT("true") : TEXT("false"));
+```
+
+<br/>
 
 
+## Unreal datatypes
 
-// print enum
+```cpp
+// Enum
 ECustomEnum EMyEnum = ECustomEnum::ValueA;
 GEngine->AddOnScreenDebugMessage(-1, 10.0f, FColor::Red, FString::Printf(TEXT("Enum: %s"), *UEnum::GetValueAsString(EMyEnum)));
 UE_LOG(LogTemp, Warning, TEXT("Enum: %s"), *UEnum::GetValueAsString(EMyEnum));
 
 
 
-// print FString
+// FString
 FString MyString = TEXT("Hello World");
 GEngine->AddOnScreenDebugMessage(-1, 10.0f, FColor::Red, FString::Printf(TEXT("FString: %s"), *MyString));
 UE_LOG(LogTemp, Warning, TEXT("FString: %s"), *MyString);
 
 
 
-// print FName
+// FName
 FName MyName = TEXT("Hello World");
 GEngine->AddOnScreenDebugMessage(-1, 10.0f, FColor::Red, FString::Printf(TEXT("FName: %s"), *MyName.ToString()));
 UE_LOG(LogTemp, Warning, TEXT("FName: %s"), *MyName.ToString());
 
 
 
-// print FVector
+// FVector
 FVector MyVector = FVector(1, 2, 3);
 GEngine->AddOnScreenDebugMessage(-1, 10.0f, FColor::Red, FString::Printf(TEXT("FVector: %s"), *MyVector.ToString()));
 UE_LOG(LogTemp, Warning, TEXT("FVector: %s"), *MyVector.ToString());
 
 
 
-// print UObject
+// FRotator
+FRotator MyRotator = FRotator(90.0f, 45.0f, 0.0f);
+GEngine->AddOnScreenDebugMessage(-1, 10.0f, FColor::Red, FString::Printf(TEXT("FRotator: %s"), *MyRotator.ToString()));
+UE_LOG(LogTemp, Warning, TEXT("FRotator: %s"), *MyRotator.ToString());
+
+
+
+// UObject
 UObject* MyObject = NewObject<UObject>(this, TEXT("MyObject"));
 GEngine->AddOnScreenDebugMessage(-1, 10.0f, FColor::Red, FString::Printf(TEXT("UObject: %s"), MyObject ? *MyObject->GetName() : TEXT("NULL")));
 UE_LOG(LogTemp, Warning, TEXT("UObject: %s"), MyObject ? *MyObject->GetName() : TEXT("NULL"));
 
+
+
+// UClass
+UClass* MyClass = UObject::StaticClass();
+GEngine->AddOnScreenDebugMessage(-1, 10.0f, FColor::Red, FString::Printf(TEXT("UClass: %s"), MyClass ? *MyClass->GetName() : TEXT("NULL")));
+UE_LOG(LogTemp, Warning, TEXT("UClass: %s"), MyClass ? *MyClass->GetName() : TEXT("NULL"));
+
 ```
 </HTMLSkeleton>

snippets/unreal-engine-5-cpp/ue-tmap-tarray-tset/index.mdx

@@ -30,6 +30,14 @@ MyMap[2] = TEXT("New Item 2");
 MyMap.Add(4, TEXT("Item 4"));
 
 
+// Appending
+TMap<int, FString> NewMap = {
+    {5, TEXT("Item 5")},
+    {6, TEXT("Item 6")},
+};
+MyMap.Append(NewMap);
+
+
 // Removing
 MyMap.Remove(2);
 
@@ -94,6 +102,11 @@ MyArray.Add(TEXT("Item 4"));                // Adds at the end
 MyArray.Insert(TEXT("Item in middle"), 2);  // Adds at given index
 
 
+// Appending
+TArray<FString> NewArray = {TEXT("Item 5"), TEXT("Item 6")};
+MyArray.Append(NewArray);
+
+
 // Removing
 MyArray.Remove(TEXT("Item 1"));        // Finds and removes all matching items
 MyArray.RemoveSingle(TEXT("Item 2"));  // Finds and removes single matching item
@@ -143,6 +156,11 @@ TSet<FString> MySet = {
 MySet.Add(TEXT("Item 5"));
 
 
+// Appending
+TSet<FString> NewSet = { TEXT("Item 6"),  TEXT("Item 7") };
+MySet.Append(NewSet);
+
+
 // Removing
 MySet.Remove(TEXT("Item 2"));
 

snippets/unreal-engine-5-cpp/ue-uclass/index.mdx

@@ -1,6 +1,6 @@
 import { HTMLSkeleton, H1, H2, UE_EDIT_OBJECT_IN_EDITOR_URL } from "./_jsx/global.jsx"
 
-export const snippet_title = "UClass in Unreal Engine 5 C++"
+export const snippet_title = "UCLASS in Unreal Engine 5 C++"
 export const snippet_category = "Unreal Engine 5 C++"
 
 <HTMLSkeleton RegisterToSiteGuide={{ category : snippet_category, title : snippet_title }}>
@@ -42,9 +42,9 @@ BlueprintSpawnableComponent  // (If class is a component) Allows the class to be
 
 Abstract  // Does not allow the class to be instantiated
 
-DefaultToInstanced
+DefaultToInstanced  // Makes sure that whenever an object of this class is created it is a unique copy, Using this avoids having to add UPROPERTY(Instanced) everywhere
 
-EditInlineNew
+EditInlineNew  // Allows properties of an instance of this class to be edited in the details panel
 ```
 
 

snippets/unreal-engine-5-cpp/ue-udelegate/index.mdx

@@ -1,6 +1,6 @@
 import { HTMLSkeleton, H1 } from "./_jsx/global.jsx"
 
-export const snippet_title = "UDelegate in Unreal Engine 5 C++"
+export const snippet_title = "UDELEGATE in Unreal Engine 5 C++"
 export const snippet_category = "Unreal Engine 5 C++"