G1R AngelScript
Scripting reference for the Gothic 1 Remake
Loading...
Searching...
No Matches
List of all members
UBlackboardComponent Class Reference
Engine » AIModule

Public Member Functions

AI|Components|Blackboard
void SetValueAsBool (FName KeyName, bool BoolValue)
bool GetLocationFromEntry (FName KeyName, FVector &ResultLocation) const
 return false if call failed (most probably no such entry in BB)
bool GetRotationFromEntry (FName KeyName, FRotator &ResultRotation) const
 return false if call failed (most probably no such entry in BB)
bool GetValueAsBool (FName KeyName) const
UClass GetValueAsClass (FName KeyName) const
uint8 GetValueAsEnum (FName KeyName) const
float32 GetValueAsFloat (FName KeyName) const
int GetValueAsInt (FName KeyName) const
FName GetValueAsName (FName KeyName) const
UObject GetValueAsObject (FName KeyName) const
FRotator GetValueAsRotator (FName KeyName) const
FString GetValueAsString (FName KeyName) const
FVector GetValueAsVector (FName KeyName) const
bool IsVectorValueSet (FName KeyName) const
 If the vector value has been set (and not cleared), this function returns true (indicating that the value should be valid). If it's not set, the vector value is invalid and this function will return false. (Also returns false if the key specified does not hold a vector.).
void ClearValue (FName KeyName)
void SetValueAsClass (FName KeyName, UClass ClassValue)
void SetValueAsEnum (FName KeyName, uint8 EnumValue)
void SetValueAsFloat (FName KeyName, float32 FloatValue)
void SetValueAsInt (FName KeyName, int IntValue)
void SetValueAsName (FName KeyName, FName NameValue)
void SetValueAsObject (FName KeyName, UObject ObjectValue)
void SetValueAsRotator (FName KeyName, FRotator VectorValue)
void SetValueAsString (FName KeyName, FString StringValue)
void SetValueAsVector (FName KeyName, FVector VectorValue)
Public Member Functions inherited from UActorComponent
void Tick (float32 DeltaSeconds)
 Event called every frame if tick is enabled.
EComponentCreationMethod GetComponentCreationMethod () const
void SetbIsEditorOnly (bool Value)
void EndPlay (EEndPlayReason EndPlayReason)
 Blueprint implementable event for when the component ends play, generally via destruction or its Actor's EndPlay.
void BeginPlay ()
 Blueprint implementable event for when the component is beginning play, called before its owning actor's BeginPlay or when the component is dynamically created if the Actor has already BegunPlay.
void MarkRenderStateDirty ()
bool HasBegunPlay () const
void SetbTickInEditor (bool Value)
bool IsVisualizationComponent () const
void SetIsVisualizationComponent (bool Value)
void AsyncPhysicsTick (float32 DeltaSeconds, float32 SimSeconds)
 Event called every async physics tick if bAsyncPhysicsTickEnabled is true.
bool GetbReplicateUsingRegisteredSubObjectList () const
 When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.
void SetbReplicateUsingRegisteredSubObjectList (bool Value)
 When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.
bool GetbReplicates () const
 Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!
void SetbReplicates (bool Value)
 Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!
bool GetbAutoActivate () const
 Whether the component is activated at creation or must be explicitly activated.
void SetbAutoActivate (bool Value)
 Whether the component is activated at creation or must be explicitly activated.
void SetbEditableWhenInherited (bool Value)
 True if this component can be modified when it was inherited from a parent actor class.
void SetbCanEverAffectNavigation (bool Value)
 Whether this component can potentially influence navigation.
bool GetbIsEditorOnly () const
 If true, the component will be excluded from non-editor builds.
bool IsBeingDestroyed () const
 Returns whether the component is in the process of being destroyed.
void SetIsReplicated (bool ShouldReplicate)
 Enable or disable replication. This is the equivalent of RemoteRole for actors (only a bool is required for components).
void DestroyComponent (UObject Object)
 Unregister and mark for pending kill a component. This may not be used to destroy a component that is owned by an actor unless the owning actor is calling the function.
bool ComponentHasTag (FName Tag) const
 See if this component contains the supplied tag.
AActor GetOwner () const
 Follow the Outer chain to get the AActor that 'Owns' this component.
void SetAutoActivate (bool bNewAutoActivate)
 Sets whether the component should be auto activate or not. Only safe during construction scripts.
bool IsActive () const
 Returns whether the component is active or not.
void ToggleActive ()
 Toggles the active state of the component.
void SetActive (bool bNewActive, bool bReset=false)
 Sets whether the component is active or not.
void Activate (bool bReset=false)
 Activates the SceneComponent, should be overridden by native child classes.
void Deactivate ()
 Deactivates the SceneComponent.
float32 GetComponentTickInterval () const
 Returns the tick interval for this component's primary tick function, which is the frequency in seconds at which it will be executed.
void AddTickPrerequisiteActor (AActor PrerequisiteActor)
 Make this component tick after PrerequisiteActor.
void AddTickPrerequisiteComponent (UActorComponent PrerequisiteComponent)
 Make this component tick after PrerequisiteComponent.
void RemoveTickPrerequisiteComponent (UActorComponent PrerequisiteComponent)
 Remove tick dependency on PrerequisiteComponent.
void SetTickableWhenPaused (bool bTickableWhenPaused)
 Sets whether this component can tick when paused.
bool IsComponentTickEnabled () const
 Returns whether this component has tick enabled or not.
void SetTickGroup (ETickingGroup NewTickGroup)
 Changes the ticking group for this component.
void RemoveTickPrerequisiteActor (AActor PrerequisiteActor)
 Remove tick dependency on PrerequisiteActor.
void SetComponentTickIntervalAndCooldown (float32 TickInterval)
 Sets the tick interval for this component's primary tick function. Does not enable the tick interval. Takes effect imediately.
void SetComponentTickInterval (float32 TickInterval)
 Sets the tick interval for this component's primary tick function. Does not enable the tick interval. Takes effect on next tick.
void SetComponentTickEnabled (bool bEnabled)
 Set this component's tick functions to be enabled or disabled. Only has an effect if the function is registered.
Public Member Functions inherited from UObject
bool MarkPackageDirty () const
void RemoveFromRoot ()
bool GetIsRooted () const
bool IsTransient () const
bool Modify (bool bAlwaysMarkDirty=true)
void SetTransactional (bool bTransactional)
bool IsSupportedForNetworking () const
UClass GetClass () const
UObject GetOuter () const
UObject GetTypedOuter (TSubclassOf< UObject > Target) const
 Traverses the outer chain searching for the next object of a certain type.
UPackage GetOutermost () const
UPackage GetPackage () const
void AddToRoot ()
UWorld GetWorld () const
FName GetName () const
FString GetFullName (const UObject StopOuter=nullptr) const
FString GetPathName (const UObject StopOuter=nullptr) const
bool IsA (const UClass Class) const
 Returns true if this object is of the specified type, or a child of that type.
void SaveConfig ()
void LoadConfig ()
void ReloadConfig ()
void CopyScriptPropertiesFrom (const UObject OtherObject)
void opCast (?&Address) const
FString ToString () const

Static Public Member Functions

Static Functions
static UBlackboardComponent Get (const AActor Actor, FName WithName=NAME_None)
static UBlackboardComponent GetOrCreate (AActor Actor, FName WithName=NAME_None)
static UBlackboardComponent Create (AActor Actor, FName WithName=NAME_None)
static UClass StaticClass ()
Static Public Member Functions inherited from UActorComponent
static UActorComponent Get (const AActor Actor, FName WithName=NAME_None)
static UActorComponent GetOrCreate (AActor Actor, FName WithName=NAME_None)
static UActorComponent Create (AActor Actor, FName WithName=NAME_None)
static UClass StaticClass ()
Static Public Member Functions inherited from UObject
static UClass StaticClass ()

Public Attributes

AI
UBlackboardData DefaultBlackboardAsset
 data asset defining entries. Will be used as part of InitializeComponent call provided BlackboardAsset hasn't been already set (via a InitializeBlackboard call).
Public Attributes inherited from UActorComponent
bool bAutoActivate
 Whether the component is activated at creation or must be explicitly activated.
TArray< TObjectPtr< UAssetUserData > > AssetUserData
 Array of user data stored with the component.
TArray< TObjectPtr< UAssetUserData > > AssetUserDataEditorOnly
 Array of user data stored with the component.
bool bReplicates
 Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!
FActorComponentTickFunction PrimaryComponentTick
 Main tick function for the Component.
bool bIsEditorOnly
 If true, the component will be excluded from non-editor builds.
bool bReplicateUsingRegisteredSubObjectList
 When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.
TArray< FName > ComponentTags
 Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.
const EComponentCreationMethod ComponentCreationMethod
const AActor Owner
 Follow the Outer chain to get the AActor that 'Owns' this component.
FActorComponentDeactivateSignature OnComponentDeactivated
 Called when the component has been deactivated.
FActorComponentActivatedSignature OnComponentActivated
 Called when the component has been activated, with parameter indicating if it was from a reset.
float32 ComponentTickInterval
 Returns the tick interval for this component's primary tick function, which is the frequency in seconds at which it will be executed.
Public Attributes inherited from UObject
const UClass Class
const UObject Outer
const UPackage Outermost
const UPackage Package
const UWorld World
const FName Name
const bool IsRooted

Member Function Documentation

◆ ClearValue()

void ClearValue ( FName KeyName)

◆ Create()

UBlackboardComponent Create ( AActor Actor,
FName WithName = NAME_None )
static

◆ Get()

UBlackboardComponent Get ( const AActor Actor,
FName WithName = NAME_None )
static

◆ GetLocationFromEntry()

bool GetLocationFromEntry ( FName KeyName,
FVector & ResultLocation ) const

return false if call failed (most probably no such entry in BB)

◆ GetOrCreate()

UBlackboardComponent GetOrCreate ( AActor Actor,
FName WithName = NAME_None )
static

◆ GetRotationFromEntry()

bool GetRotationFromEntry ( FName KeyName,
FRotator & ResultRotation ) const

return false if call failed (most probably no such entry in BB)

◆ GetValueAsBool()

bool GetValueAsBool ( FName KeyName) const

◆ GetValueAsClass()

UClass GetValueAsClass ( FName KeyName) const

◆ GetValueAsEnum()

uint8 GetValueAsEnum ( FName KeyName) const

◆ GetValueAsFloat()

float32 GetValueAsFloat ( FName KeyName) const

◆ GetValueAsInt()

int GetValueAsInt ( FName KeyName) const

◆ GetValueAsName()

FName GetValueAsName ( FName KeyName) const

◆ GetValueAsObject()

UObject GetValueAsObject ( FName KeyName) const

◆ GetValueAsRotator()

FRotator GetValueAsRotator ( FName KeyName) const

◆ GetValueAsString()

FString GetValueAsString ( FName KeyName) const

◆ GetValueAsVector()

FVector GetValueAsVector ( FName KeyName) const

◆ IsVectorValueSet()

bool IsVectorValueSet ( FName KeyName) const

If the vector value has been set (and not cleared), this function returns true (indicating that the value should be valid). If it's not set, the vector value is invalid and this function will return false. (Also returns false if the key specified does not hold a vector.).

◆ SetValueAsBool()

void SetValueAsBool ( FName KeyName,
bool BoolValue )

◆ SetValueAsClass()

void SetValueAsClass ( FName KeyName,
UClass ClassValue )

◆ SetValueAsEnum()

void SetValueAsEnum ( FName KeyName,
uint8 EnumValue )

◆ SetValueAsFloat()

void SetValueAsFloat ( FName KeyName,
float32 FloatValue )

◆ SetValueAsInt()

void SetValueAsInt ( FName KeyName,
int IntValue )

◆ SetValueAsName()

void SetValueAsName ( FName KeyName,
FName NameValue )

◆ SetValueAsObject()

void SetValueAsObject ( FName KeyName,
UObject ObjectValue )

◆ SetValueAsRotator()

void SetValueAsRotator ( FName KeyName,
FRotator VectorValue )

◆ SetValueAsString()

void SetValueAsString ( FName KeyName,
FString StringValue )

◆ SetValueAsVector()

void SetValueAsVector ( FName KeyName,
FVector VectorValue )

◆ StaticClass()

UClass StaticClass ( )
static

Member Data Documentation

◆ DefaultBlackboardAsset

UBlackboardData DefaultBlackboardAsset

data asset defining entries. Will be used as part of InitializeComponent call provided BlackboardAsset hasn't been already set (via a InitializeBlackboard call).