G1R AngelScript
Scripting reference for the Gothic 1 Remake
Loading...
Searching...
No Matches
UCameraModifier Class Reference

A CameraModifier is a base class for objects that may adjust the final camera properties after being computed by the APlayerCameraManager (@see ModifyCamera). A CameraModifier can be stateful, and is associated uniquely with a specific APlayerCameraManager. More...

Public Member Functions

Functions
void BlueprintModifyPostProcess (float32 DeltaTime, float32 &PostProcessBlendWeight, FPostProcessSettings &PostProcessSettings)
 Called per tick that the modifier is active to allow Blueprinted modifiers to modify the camera's postprocess effects. Scaling by Alpha happens after this in code, so no need to deal with that in the blueprint.
void SetbDebug (bool Value)
 If true, enables certain debug visualization features.
bool GetbExclusive () const
 If true, no other modifiers of same priority allowed.
void SetbExclusive (bool Value)
 If true, no other modifiers of same priority allowed.
void BlueprintModifyCamera (float32 DeltaTime, FVector ViewLocation, FRotator ViewRotation, float32 FOV, FVector &NewViewLocation, FRotator &NewViewRotation, float32 &NewFOV)
 Called per tick that the modifier is active to allow Blueprinted modifiers to modify the camera's transform. Scaling by Alpha happens after this in code, so no need to deal with that in the blueprint.
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 UClass StaticClass ()
Static Public Member Functions inherited from UObject
static UClass StaticClass ()

CameraModifier

APlayerCameraManager CameraOwner
 Camera this object is associated with.
float32 AlphaInTime
 When blending in, alpha proceeds from 0 to 1 over this time.
float32 AlphaOutTime
 When blending out, alpha proceeds from 1 to 0 over this time.
float32 Alpha
 Current blend alpha.
const AActor ViewTarget
bool bExclusive
 If true, no other modifiers of same priority allowed.
uint8 Priority
 Priority value that determines the order in which modifiers are applied. 0 = highest priority, 255 = lowest.
bool IsDisabled () const
bool IsPendingDisable () const
void DisableModifier (bool bImmediate=false)
 Disables this modifier.
void EnableModifier ()
 Enables this modifier.
AActor GetViewTarget () const

Additional Inherited Members

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

Detailed Description

A CameraModifier is a base class for objects that may adjust the final camera properties after being computed by the APlayerCameraManager (@see ModifyCamera). A CameraModifier can be stateful, and is associated uniquely with a specific APlayerCameraManager.

Member Function Documentation

◆ BlueprintModifyCamera()

void BlueprintModifyCamera ( float32 DeltaTime,
FVector ViewLocation,
FRotator ViewRotation,
float32 FOV,
FVector & NewViewLocation,
FRotator & NewViewRotation,
float32 & NewFOV )

Called per tick that the modifier is active to allow Blueprinted modifiers to modify the camera's transform. Scaling by Alpha happens after this in code, so no need to deal with that in the blueprint.

Parameters
DeltaTimeChange in time since last update
ViewLocationThe current camera location.
ViewRotationThe current camera rotation.
FOVThe current camera fov.
NewViewLocation(out) The modified camera location.
NewViewRotation(out) The modified camera rotation.
NewFOV(out) The modified camera FOV.

◆ BlueprintModifyPostProcess()

void BlueprintModifyPostProcess ( float32 DeltaTime,
float32 & PostProcessBlendWeight,
FPostProcessSettings & PostProcessSettings )

Called per tick that the modifier is active to allow Blueprinted modifiers to modify the camera's postprocess effects. Scaling by Alpha happens after this in code, so no need to deal with that in the blueprint.

Parameters
DeltaTimeChange in time since last update
PostProcessBlendWeight(out) Blend weight applied to the entire postprocess structure.
PostProcessSettings(out) Post process structure defining what settings and values to override.

◆ DisableModifier()

void DisableModifier ( bool bImmediate = false)

Disables this modifier.

Parameters
bImmediatetrue to disable with no blend out, false (default) to allow blend out

◆ EnableModifier()

void EnableModifier ( )

Enables this modifier.

◆ GetbExclusive()

bool GetbExclusive ( ) const

If true, no other modifiers of same priority allowed.

◆ GetViewTarget()

AActor GetViewTarget ( ) const
Returns
Returns the actor the camera is currently viewing.

◆ IsDisabled()

bool IsDisabled ( ) const
Returns
Returns true if modifier is disabled, false otherwise.

◆ IsPendingDisable()

bool IsPendingDisable ( ) const
Returns
Returns true if modifier is pending disable, false otherwise.

◆ SetbDebug()

void SetbDebug ( bool Value)

If true, enables certain debug visualization features.

◆ SetbExclusive()

void SetbExclusive ( bool Value)

If true, no other modifiers of same priority allowed.

◆ StaticClass()

UClass StaticClass ( )
static

Member Data Documentation

◆ Alpha

float32 Alpha

Current blend alpha.

◆ AlphaInTime

float32 AlphaInTime

When blending in, alpha proceeds from 0 to 1 over this time.

◆ AlphaOutTime

float32 AlphaOutTime

When blending out, alpha proceeds from 1 to 0 over this time.

◆ bExclusive

bool bExclusive

If true, no other modifiers of same priority allowed.

◆ CameraOwner

APlayerCameraManager CameraOwner

Camera this object is associated with.

◆ Priority

uint8 Priority

Priority value that determines the order in which modifiers are applied. 0 = highest priority, 255 = lowest.

◆ ViewTarget

const AActor ViewTarget