Yureka LogoDocs
GitHubyureka.dev

Core System Overview

The core system contains the main classes that manage the Grid Placement System's functionality through a modular, orchestrated architecture.

System Architecture

The Grid Placement System uses a layered architecture where components work together to provide comprehensive placement functionality:

PlacementHelper
↓ (Simplified API Layer)
PlacementSystemComponent
├── PlacementObjectRegistry
├── SurfaceManager
├── ObjectManager
├── PlacementValidator
├── InputHandler
├── PlacementCameraController
└── GridSnapper

PlaceableObjectInterface
└── DirectionalArrowComponent

Components

PlacementHelperSimplified API Layer

Blueprint Function Library providing easy-to-use static functions for common placement operations. Handles component management automatically and offers global access from anywhere in your project. Ideal for rapid prototyping and simple placement scenarios.
View Details

PlacementSystemComponentMain System Orchestrator

Core component that coordinates camera controls, input handling, object validation, surface detection, visual feedback, and audio cues. Must be added to your Player Pawn. Manages all internal subsystems and provides comprehensive placement functionality.
View Details

PlacementObjectRegistryObject Database Manager

Component that maintains the central registry of all placeable objects. Supports both DataTable configuration for designer workflows and runtime registration for dynamic content systems. Provides category organization and event integration.
View Details

PlaceableObjectInterfacePlaceable Object Contract

Interface that all placeable objects must implement to work with the placement system. Defines placement behavior, surface compatibility, and integration points. Provides methods for editing callbacks and directional arrow management.
View Details

DirectionalArrowComponentVisual Direction Indicator

Optional component for placeable objects that provides directional arrows to show object orientation during placement and editing. Features configurable directions, materials, and automatic visibility management.
View Details

Integration Approach

Simple Integration

Use PlacementHelper for straightforward placement needs. Provides one-function setup and global access without component management complexity.

Advanced Integration

Access PlacementSystemComponent directly for full customization, extensive event handling, and complete control over the placement pipeline.

Flexible Architecture

The system is designed for flexibility: start with PlacementHelper for immediate results, then migrate to direct component access as your needs become more sophisticated.