Getting started
Like every Pulse plugin, Pulse Build is used in four steps: Set Up, Create, Test and Check. The Pulse window (Tools > Pulse > Pulse) walks through them, and its Guide shows each step in the editor. The list at the start of each section comes from the plugin itself; the text after it goes into the details.
Set Up
The Pulse window (Tools > Pulse > Pulse, tab Workflow, step Set Up) checks each of these and fixes it with a click:
- Add the Pulse Build component to the Player Pawn. The builder of a player: preview, tools, requests, undo. On the pawn or the controller.
- Optional: Connect with PulseGameplay: PulseBuildGameplayBridge. Build kits, chests, damage on pieces, build menus on the HUD, building by holding the interaction.
- Optional: Connect with PulseSkill: PulseBuildSkillBridge. Skill ranks unlock build pieces and catalogs (skill grant Unlock Build Pieces); the build menu shows them.
- Optional: Connect with PulseOnline: PulseBuildOnlineBridge. Party rights: the members of an owner’s party build in the owner’s claims and change the owner’s pieces.
- Optional: Connect with PulseAI: PulseAIBuildBridge. Raids: agents of Pulse AI find hostile pieces, move to them and damage them; doors of actor pieces get navigation links.
- Optional: Connect with PulseWorld: PulseWorldBuildBridge. Players dig and fill the ground of Pulse World only inside their own claims (action Terrain); pieces look at their ground again after a dig.
- Optional: Connect with PulseFactionTerritory: PulseBuildFactionTerritoryBridge. Claim pieces only on a territory the builder’s faction owns; members of a faction share claims.
- Optional: Connect with PulseNav: PulseNavBuildBridge. Doors and stairs of building pieces become navigation links of Pulse Nav; buildings never change the coarse level.
- Optional: Build only inside own claims (rule In Own Claim in the Default Rules) Optional. Every piece then needs a claim of the builder (owner, team or group); claim pieces such as a totem may stand anywhere and make the first claim. Pieces with Use Default Rules off stay free.
Enable the plugin
Enable PulseFoundation and Pulse Build in the plugin browser (or in the .uproject) and restart the editor. Pulse Build also enables the engine plugins CommonUI, EnhancedInput and ModelViewViewModel for its UI modules.
Give the player a builder
The builder of a player is the Pulse Build component (UPulseBuildComponent) on the pawn or the player controller. Add Automatically in the Pulse window turns on Build Component in Project Settings > Pulse > Build, which adds it to the player pawn when it spawns; or add it to your Blueprint yourself. Give it a catalog (see Create), or turn Require Catalog off for a creative builder that can build every piece.
Drive the component from input:
| Input | Call |
|---|---|
| Pick a piece | SelectPiece(Piece) (or SelectHotbarSlot(Index), or the build menu) |
| Place / remove / confirm | Confirm() |
| Turn | RotatePreview(Steps) |
| Raise or lower | AddHeightOffset(Delta) |
| Other tools | SetTool(Remove / Move / Rotate / Pipette / Copy / Upgrade / Repair / Work) |
| Stop | StopBuilding() |
The component traces from the player’s view every frame while a tool is active, shows a green or red ghost and sends only the final transform to the server, which checks everything again.
Create
New assets come from Add > Pulse > Build in the content browser or New in the Pulse window:
- Building Piece (
UPulseBuildPieceDefinition, the main asset): A wall, floor, roof or any other piece; opens in the workshop with the creation wizard. - Building Catalog (
UPulseBuildCatalog): The pieces a player may build. - Starter content: The house kit (foundation, wall, doorway, ceiling, roof, stairs) and the spline kit (fence, road with crossing, stone wall, pipe), each with its catalog. Add Starter Content copies it to
/Game/Pulse/PulseBuild.
Make a piece
- Add > Pulse > Build > Building Piece in the content browser (or New Building Piece in the Pulse window). The piece opens in its workshop with the creation wizard; Skip it to set everything by hand. To start from the house and spline kits of the example map instead, use Add Starter Content.
- Set Display Name, Category (
Pulse.Build.Category.*) and Mesh. The origin of a piece is its bottom center; move the mesh with Mesh Transform if the mesh’s pivot is elsewhere. - Pick a Placement mode:
- Free: anywhere on a surface, turned in Rotation Step degrees.
- Grid: snapped to the grid of the settings (cell size, footprint, floors).
- Sockets: snapped to sockets of other pieces (
bAllowGroundlets foundations stand on the ground). - Spline: points along a path (needs the Spline trait).
- Optional traits: Costs, Construction, Health, Tiers, Integrity, … (see Pieces).
The piece’s details panel shows a 3D preview with its bounds and sockets.
Make a catalog
Create a Building Catalog with the pieces the player may build and add it to Catalogs of the build component.
Test
- Play Example in the Pulse window opens
/PulseBuild/Examples/LV_PulseBuildExampleand starts Play in Editor. - Then the cheat
PulseBuildGrantgives the player what the plugin needs. - Build the house kit and the spline kit of the example map.
The test level /PulseBuild/Examples/LV_PulseBuildExample has a house kit and a spline kit in /PulseBuild/Examples. It works as listen server + client too; besides PulseBuildGrant these cheats help:
PulseBuildPlace DA_PulseBuild_Foundation
PulseBuildMenu
PulseBuildInfo
All cheats are listed on the Console page.
Check
- Check in the Pulse window, Check All there (console
Pulse.Check) or the commandlet-run=PulseCheck -Plugins=PulseBuildchecks the setup and validates every Building Piece and Building Catalog in the project.
The workshop of a piece shows the problems of that piece while you edit it (Validation tab, with quick fixes); Check does it for every piece and catalog of the project, together with the setup.
Next steps
- Costs and construction time: Construction.
- Saving the building world: Save and load or the PulseSave bridge.
- Items as costs, combat damage, HUD menus: PulseGameplay integration.