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
  • Overview
  • Add the UBS Component
  • Access the UBS Component in the Blueprint
  • Enable Build Mode
  • Place a Buildable
  • Disable Build Mode
  1. Code Systems
  2. Ultimate Building System Framework (UBS)

Quick Start

PreviousCollision ChannelsNextUltimate Building System Component (UBS)

Last updated 7 months ago

Overview

In this Quick Start Guide, you'll learn how to set up and use the UBS Component to enable build mode in your character. You'll configure the inputs for enabling and disabling build mode, as well as for placing buildable objects.

Add the UBS Component

First, add the UBS Component to the character you want to use for building. This component will handle the functionality required for enabling and disabling build mode.

Access the UBS Component in the Blueprint

In your character's blueprint, get a reference to the UBS Component in the graph. This will allow you to use its functions to manage build mode.

Enable Build Mode

Use the Try Enable Build Mode function to enter build mode. This function has two input parameters:

  • Buildable Definition: Set this to the buildable definition you want to use. Our example will be using the DA_Wooden_Foundation_Def

  • Proxy Class: This defines the class which we'll be using for the proxy. For this example we'll be using UBF_BuildableProxy class.

Hook this function up to the input you want the player to use for enabling build mode. For this example, we’ll use the B key as the build mode toggle.

Place a Buildable

Use the Try Build function to place a buildable object. Hook this function to the Left Mouse Button input event, so the player can place a buildable while in build mode.

You can turn the Disable Build Mode on Build Success off if you want the player to be able to continuously place the same buildable with the build mode disabling.

Disable Build Mode

Use the Try Disable Build Mode function to exit build mode. For this tutorial, we’ll connect this to the Right Mouse Button input event.

Note: It's recommended that you set up your own input system, such as the enhanced input system, rather than relying on raw input events like we’re doing in these examples. This will give you more control and flexibility for future customization.

πŸ’»
βš’οΈ
Enabling Build Mode
Placing a Buildable
Disabling Build Mode