Hivemind
  • 🔍Start Here
  • 💻Code Systems
    • 🐎Ultimate Horse System
      • Documentation
      • Integration Guide
    • 🚀Ultimate Spaceship System (USS) Knowledge Base
      • 📖USS Documentation
      • 🧩USS Integration Guide
    • 🚂Ultimate Train System
      • Dokumentation
      • Integration Guide
    • ⚔️Modular Character System
      • Documentation
      • Trailer
    • ⚒️Ultimate Building System Framework (UBS)
      • 🔍Introduction
      • Installation
        • Example Content Setup
      • Developer Settings
        • Initial Setup
        • Collision Channels
      • Quick Start
      • Ultimate Building System Component (UBS)
      • Buildable Definition
      • Buildable
        • Actions
        • Tag Qualifier Conditions
        • Dependencies
      • Proxy Behaviour
        • Trace Behaviour
        • Proxy Location Offset
        • Placement Conditions
        • Post Build Events
      • Using your own Meshes
      • Global Function References
  • ✨VFX
    • 🩸Realistic Blood VFX
      • Documentation
      • Video Tutorial
    • 🩸Stylized Blood VFX
      • Documentation
    • 💥Realistic Gun Effects
      • Documentation
    • ☁️Smoke & Fog VFX Knowledge Base
      • 📖Smoke & Fog Documentation
      • 📸Video Tutorials
  • 🏡Environments
    • 🌃 Cyberpunk City
      • Level Instance
      • Tech Tools
    • 🏰Modular Castle & Dungeon
      • Documentation
      • Trailer
    • 🏘️Modular Rural Town
      • Documentation
      • Trailer
Powered by GitBook
On this page
  • Properties
  • Functions
  1. Code Systems
  2. Ultimate Building System Framework (UBS)

Ultimate Building System Component (UBS)

PreviousQuick StartNextBuildable Definition

Last updated 6 months ago

The Building System Component manages everything related to the placement of buildables. It should be added to the player pawn to enable the ability to place buildables in the game.

You can change the Min Max values of the Proxy Location Offset values by simply changing the Min/Max values on the UBS Components Detail Panel.


Properties

  • DebugTraceType: Determines the type of debug trace to use.

  • ProxyLocationOffset: A vector that sets the offset for the proxy location.

  • MinProxyLocationOffset: Defines the minimum vector offset for proxy placement.

  • MaxProxyLocationOffset: Defines the maximum vector offset for proxy placement.


Functions

  • IsBuildModeEnabled(): Returns whether build mode is currently enabled.

  • GetClosestMatchingProxySocket(): Finds the closest matching proxy socket for a given buildable actor and socket.

  • GetProxyActor(): Returns the current ProxyActor being used.

  • PerformTrace(): Executes a trace and outputs the result.

  • SearchForBuildable(): Searches for a buildable object within a specific radius of a given location.

  • YawProxyBy(): Rotates the proxy by a specified yaw value.

  • PitchProxyBy(): Rotates the proxy by a specified pitch value.

  • TryEnableBuildMode(): Attempts to enable build mode with the provided buildable definition and proxy class.

  • TryDisableBuildMode(): Disables build mode.

  • TryBuild(): Attempts to build the object and optionally disables build mode on success.

  • MoveToNextConnection(): Moves the proxy to the next available connection point.

  • AddVectorOffset(): Adds an offset to the vector, with an option to ignore minimum and maximum constraints.

  • AddUpOffset(): Adds an upward offset to the proxy.

  • AddForwardOffset(): Adds a forward offset to the proxy.

  • AddRightOffset(): Adds a rightward offset to the proxy.

  • OnBuildModeStateChange(): Delegate/Event that triggers when the build mode state changes.

💻
⚒️
UBS Component's Detail Panel