Skip to content

Behavior Function Reference

Pro Behavior

This page lists the built-in functions exposed by UJ2TagBehaviorFunctionLibrary. Pure functions are expressions. Callable functions are actions. Custom behavior functions are documented in Behavior Public API.

FunctionOutputPurpose
IsObjectValidResult boolReturns true when the object reference is valid.
IsObjectOfClassResult boolChecks whether an object is of a class; can require exact class match.
ObjectEqualsResult boolChecks whether two object references point to the same object.
ObjectNotEqualsResult boolChecks whether two object references are different.
GetObjectNameResult stringReturns the internal object name, or empty string for invalid objects.
GetObjectDisplayNameResult stringReturns the Actor label or display-safe object name.
GetObjectClassResult classReturns the object’s class, or none for invalid objects.
ObjectIsActorResult boolReturns true when the object is an Actor.
ObjectIsComponentResult boolReturns true when the object is an Actor Component.
ObjectIsAssetResult boolReturns true when the object is an asset.
FunctionOutputPurpose
ActorHasComponentResult boolChecks whether an Actor has a component of the given class.
GetOwnerActorResult ActorReturns the owner Actor for a component.
FunctionOutputPurpose
ObjectHasTagResult boolChecks exact tag or child tag match on an Actor or Component.
ObjectHasExactTagResult boolChecks only exact tag name match.
ObjectHasTagMatchingParentResult boolChecks whether any object tag is equal to or below a parent tag.
ObjectHasAnyTagResult boolChecks whether the object has at least one comma-separated tag.
ObjectHasAllTagsResult boolChecks whether the object has every comma-separated tag.
ObjectHasNoneOfTagsResult boolChecks whether the object has none of the comma-separated tags.
TagEqualsResult boolCompares two normalized tag names for equality.
TagNotEqualsResult boolCompares two normalized tag names for inequality.
TagMatchesParentResult boolChecks whether a tag equals or is below a parent tag path.
GetTagParentResult nameReturns the direct parent tag path.
GetParentTagsResult stringReturns all parent tag paths as comma-separated text.
GetTagRootResult stringReturns the root segment of a tag path.
GetTagLeafNameResult stringReturns the final segment of a tag path.
FunctionOutputPurpose
BoolEqualsResult boolReturns true when both boolean values are equal.
BoolNotEqualsResult boolReturns true when both boolean values are different.
FunctionOutputPurpose
IntEqualsResult boolA == B.
IntNotEqualsResult boolA != B.
IntGreaterThanResult boolA > B.
IntGreaterOrEqualResult boolA >= B.
IntLessThanResult boolA < B.
IntLessOrEqualResult boolA <= B.
FunctionOutputPurpose
FloatEqualsResult boolReturns true when two floats are nearly equal within tolerance.
FloatNotEqualsResult boolReturns true when two floats differ by more than tolerance.
FloatGreaterThanResult boolA > B.
FloatGreaterOrEqualResult boolA >= B.
FloatLessThanResult boolA < B.
FloatLessOrEqualResult boolA <= B.
FunctionOutputPurpose
StringEqualsResult boolCompares strings for equality; optional case-insensitive mode.
StringNotEqualsResult boolCompares strings for inequality; optional case-insensitive mode.
StringContainsResult boolChecks whether a string contains a search value.
StringStartsWithResult boolChecks whether a string starts with a prefix.
StringEndsWithResult boolChecks whether a string ends with a suffix.
StringIsEmptyResult boolChecks whether trimmed text is empty.
StringMatchesWildcardResult boolChecks a string against a wildcard pattern.
FunctionOutputPurpose
ClassEqualsResult boolChecks whether two class references are the same.
ClassNotEqualsResult boolChecks whether two class references are different.
ClassIsChildOfResult boolChecks whether a class inherits from a parent class.
FunctionOutputPurpose
IsEventTypeResult boolChecks whether the active behavior was triggered by the selected event type.
FunctionOutputPurpose
PrintDebugMessageResult boolLogs a debug message and prints on-screen debug output.
LogMessageResult boolWrites a behavior log message with Info, Warning, or Error severity.
FunctionOutputPurpose
CreateIssueMessageResult boolCreates a structured behavior issue message; can suppress duplicates with OnlyOnce.
ClearIssueMessagesResult intClears remembered issue messages and returns the number removed.
FunctionOutputPurpose
AddTagToObjectResult boolAdds a tag to an Actor or Actor Component.
RemoveTagFromObjectResult boolRemoves an exact tag from an Actor or Actor Component.
ClearTagsFromObjectResult intClears all tags from an Actor or Actor Component and returns removed count.
ReplaceTagOnObjectResult boolReplaces an exact old tag with a new tag.
AddTagsToObjectResult intAdds comma-separated tags and returns added count.
RemoveTagsFromObjectResult intRemoves comma-separated tags and returns removed count.
FunctionOutputPurpose
AddComponentToActorResult boolAdds a component of the requested class to an Actor; can skip if one already exists.
RemoveComponentFromActorResult boolRemoves the first matching component from an Actor.
FunctionOutputPurpose
ExecuteBehaviorResult boolExecutes a referenced behavior asset or section with an optional target object context.
StopBehaviorResult boolRequests that the current behavior stop after this action.

Custom functions follow the same split:

  • pure functions become expression functions
  • non-pure callable functions become action functions
  • supported parameter and output types are listed in Input and Output Types