-
Notifications
You must be signed in to change notification settings - Fork 62
Plugin Metadata Specifiers Reference
Plugin supports various metadata specifiers.
Some examples can be found here.
Specify color for item in Subsystem Browser Panel when Enable Coloring option is On.
Color value can be either an export string, hex code, common name or a configurable value from settings.
Examples:
UCLASS(meta=(SBColor="(R=128, G=128, B=0)"))UCLASS(meta=(SBColor="#ff0000"))UCLASS(meta=(SBColor="green"))
Specify a User Tooltip for Item within Subsystem Browser Panel.
Examples:
- Text
UCLASS(meta=(SBTooltip="My Uber Subsystem"))(will use text value) - Function:
UCLASS(meta=(SBTooltip="GetSubsystemTooltip"))(will call function with specified name) - Property:
UCLASS(meta=(SBTooltip="SubsystemTooltipDesc"))(will read property with specified name)
Specify dynamic value of Owner for Item within Subsystem Browser Panel.
Examples:
- Text:
UCLASS(meta=(SBOwnerName ="My Uber Subsystem"))(will use text value) - Function:
UCLASS(meta=(SBOwnerName ="GetSubsystemTooltip"))(will call function with specified name) - Property:
UCLASS(meta=(SBOwnerName ="SubsystemTooltipDesc"))(will read property with specified name)
Hides property from displaying in Details View.
Name of a member UFUNCTION within class that will supply list of objects shown as child nodes of subsystem in browser panel.
Examples:
UCLASS(meta=(SBGetSubobjects="GetNestedObjects"))
UFUNCTION()
TArray<UObject*> GetNestedObjects() const;
SBGetSubobjects=auto would collect search for any member uproperty or a subobject with SBSubobject meta specifier.
UCLASS(meta=(SBGetSubobjects="auto"))
// select by property
UPROPERTY(meta=(SBSubobject))
TObjectPtr<UMyHelper> HelperObject;
Specify Section for Subsystem displayed within Subsystem Settings Panel.
Default is Class::GetDisplayNameText
Example: UCLASS(meta=(SBSection = "Game Time Subsystem"))
Specify Section Description for Subsystem displayed within Subsystem Settings Panel.
Default is Class::GetTooltipText
Example: UCLASS(meta=(SBSectionDesc = "Specifies date time settings within game world"))