AAndromedaWorkstation¶

Kind: class Source: Source/Andromeda/Workstation/AndromedaWorkstation.h Base classes: AActor, IAndromedaFocusCandidateProviderInterface

Details¶

Abstract base actor for workstation placement, screen prompt, and placed-object usage behavior.

Public Properties¶

Protected Properties¶

Public Methods¶

Protected Methods¶

Members¶

RootSceneComponent¶

TObjectPtr< USceneComponent > RootSceneComponent

Root scene component for the workstation actor.

MeshComponent¶

TObjectPtr< UStaticMeshComponent > MeshComponent

Visible workstation mesh and visibility trace blocker.

PlacementValidatorComponent¶

TObjectPtr< UAndromedaWorkstationPlacementValidatorComponent > PlacementValidatorComponent

Component that discovers placement query volumes and reports correctly placed objects.

DefaultPlacementVolumeComponent¶

TObjectPtr< UBoxComponent > DefaultPlacementVolumeComponent

Default placement query volume tagged for the placement validator.

ScreenComponent¶

TObjectPtr< UAndromedaWorkstationScreenComponent > ScreenComponent

World-space widget surface that implements prompt and interaction interfaces.

CapabilityEventsComponent¶

TObjectPtr< UAndromedaCapabilityEventsComponent > CapabilityEventsComponent

Shared event source for screen prompt and interaction refresh.

EmptyPromptText¶

FText EmptyPromptText

Workstation-specific empty prompt text.

UseWorkstationPromptText¶

FText UseWorkstationPromptText

Workstation-specific use prompt text.

AAndromedaWorkstation¶

AAndromedaWorkstation::AAndromedaWorkstation()

Creates mesh, placement validator, default volume, screen, and capability event components.

GetOwningStation¶

AAndromedaStation * AAndromedaWorkstation::GetOwningStation() const

Returns the station this workstation belongs to.

Returns:

Station whose access volume contains this workstation, or nullptr when none is found.

GetStationDatabankComponent¶

UAndromedaStationDatabankComponent * AAndromedaWorkstation::GetStationDatabankComponent() const

Returns the owning station databank, if any.

Returns:

Spatially resolved station's databank component, or nullptr when no owning station exists.

GetCapabilityEventsComponent¶

UAndromedaCapabilityEventsComponent * AAndromedaWorkstation::GetCapabilityEventsComponent() const

Returns the screen prompt and interaction event source.

Returns:

CapabilityEventsComponent used by workstation screen prompt and interaction subscribers.

CanInteractWithScreen¶

bool AAndromedaWorkstation::CanInteractWithScreen() const

Reports whether the screen can be interacted with. This is only possible when exactly one usable placed object is available.

Returns:

True when FindSingleUsablePlacedObject returns one object.

GetScreenPrompt¶

FText AAndromedaWorkstation::GetScreenPrompt() const

Returns use prompt text when screen interaction is available.

Returns:

UseWorkstationPromptText when interaction is available, otherwise empty text.

InteractWithScreen¶

void AAndromedaWorkstation::InteractWithScreen()

Uses the current placed object and notifies prompt state.

Finds the single correctly placed acceptable object, tries to use it, then broadcasts an capability change when prompts and interaction state may need to refresh.

CanAcceptObjectAtTransform¶

bool AAndromedaWorkstation::CanAcceptObjectAtTransform(UObject *CandidateObject, const FTransform &CandidateTransform) const

Validates object type and spatial placement at a proposed transform.

Combines subclass acceptance rules with placement-validator geometry checks so placement mode can warn before committing.

Parameters:

Returns:

True when this workstation can accept the object at the transform.

GetFocusCandidate_Implementation¶

UObject * AAndromedaWorkstation::GetFocusCandidate_Implementation(APawn *ViewingPawn, const FHitResult &Hit) const override

Routes screen component hits to the screen focus candidate.

Mesh, placement volume, anti-volume, and other workstation component hits return nullptr.

Parameters:

Returns:

ScreenComponent when Hit targets the screen; otherwise nullptr.

CanAcceptObject¶

bool AAndromedaWorkstation::CanAcceptObject(UObject *CandidateObject) const

Base object eligibility check for placement acceptance.

Subclasses override this to restrict accepted object types.

Parameters:

Returns:

True when the object is non-null by default.

CanUsePlacedObject¶

bool AAndromedaWorkstation::CanUsePlacedObject(UObject *CandidateObject) const

Base object eligibility check for screen use.

Parameters:

Returns:

True when the object is non-null by default.

TryUsePlacedObject¶

bool AAndromedaWorkstation::TryUsePlacedObject(UObject *Object)

Extension point executed by screen interaction.

Base implementation checks CanUsePlacedObject. Subclasses perform scanner or packager work.

Parameters:

Returns:

True when the object was used.

FindSingleCorrectlyPlacedAcceptableObject¶

UObject * AAndromedaWorkstation::FindSingleCorrectlyPlacedAcceptableObject() const

Returns a single acceptable placed object, or null unless the count is exactly one. This is different from FindSingleUsablePlacedObject as it only considers objects that are correctly placed on the workstation without checking if the workstation can work on them.

Ambiguous placement intentionally disables workstation use.

Returns:

One acceptable object, or nullptr when there are zero or multiple.

FindSingleUsablePlacedObject¶

UObject * AAndromedaWorkstation::FindSingleUsablePlacedObject() const

Returns a single acceptable object that can currently be used with the workstation. This is different from FindSingleCorrectlyPlacedAcceptableObject as it considers the workstation's state and capabilities and whether the workstation can actually work on the object

Returns:

One usable object, or nullptr when placement is ambiguous or CanUsePlacedObject fails.

GetCorrectlyPlacedAcceptableObjects¶

TArray< UObject * > AAndromedaWorkstation::GetCorrectlyPlacedAcceptableObjects() const

Collects unique correctly placed objects accepted by this workstation.

Returns:

Accepted objects after null, duplicate, and subclass filters.

SubscribeToPlacementEvents¶

void AAndromedaWorkstation::SubscribeToPlacementEvents()

Subscribes to placement-domain commit events.

UnsubscribeFromPlacementEvents¶

void AAndromedaWorkstation::UnsubscribeFromPlacementEvents()

Unsubscribes from placement-domain commit events.

HandlePlacementCommitted¶

void AAndromedaWorkstation::HandlePlacementCommitted(AActor *PlacedActor, const FTransform &PlacedTransform)

Handles placement commits that can change this workstation's spatially discovered state.

Parameters:

OnConstruction¶

void AAndromedaWorkstation::OnConstruction(const FTransform &Transform) override

Configures placement query volumes in editor construction.

Parameters:

PostInitializeComponents¶

void AAndromedaWorkstation::PostInitializeComponents() override

Configures placement query volumes at runtime initialization.

BeginPlay¶

void AAndromedaWorkstation::BeginPlay() override

Subscribes to world placement events.

EndPlay¶

void AAndromedaWorkstation::EndPlay(const EEndPlayReason::Type EndPlayReason) override

Unsubscribes from world placement events.

Parameters: