Theory

• Devices in the game are just entity nodes, which additionally have the option to specify device connections

  • These can be used to e.g. Connect a door terminal to the door it controls

Guides

• Custom fast travel points

• Custom elevators

• Creating Security Areas

Requirements

Tools

• Object Spawner (v.0.8. or newer)

• ArchiveXL (1.20 or newer)

• Codeware (1.14.1 or newer)

• WolvenKit (With latest version of Object Spawner import script)

Knowledge

• You need to have a basic understanding of:

  • Working with WolvenKit

  • Using Object Spawner (Spawning things and importing into WolvenKit)

Spawning nodes

Overview

• In this guide, we will build a simple elevator with 2 floors

• For this we will need 3 device nodes:

  • An elevator object

  • Two elevator terminals

• Additionally, we will need two markers:

  • One per floor

  • These determine the position to which the elevator drives

Spawning Devices

• For the elevator, we will use base\gameplay\devices\elevators\megabuilding_elevator\megabuilding_lift_1.ent

  • Spawn it as Device, and place it somewhere

• For the terminals we will use base\gameplay\devices\elevators\terminals\elevator_floor_terminal_1.ent

  • Spawn two of them as Device, and place one per stop

Spawning Markers

• For the markers, select Meta -> Static Markerin Object Spawner

• Spawn two markers

• In order to properly position them, do as follows for each marker / floor:

  • Move the elevator device spawned earlier to the position you want it to stop in

  • Right-Click the position (Under the Transform header) of the elevator device, and select Copy position and rotation

  • Select one marker, right click its position field, and select `Paste position and rotation`

  • Now you will have moved the marker into the same spot as the elevator

  • Repeat for each marker / floor

• Make sure that once you are done setting up the markers, you move the elevator back to the position of the starting floor

Assigning NodeRef's

• In order to link and reference all the spawned object, each one will need its own, unique NodeRef

• Expand the World Nodeheader and fill the NodeRef field with a unique string

• In the end, we will have assigned 5 NodeRef's

• For example:

  • $/terminal_top, $/terminal_bottom, $/marker_top, $/marker_bottom, $/elevator

Linking Devices

• Next we need to tell the elevator which floors it can use

• To do this, we will go to the Device -> Device Connections header of the elevator

• Add one entry for each floor / terminal

  • Fill the device class name field (On the left), with the device class name of the terminal

    • In our case this would be ElevatorFloorTerminalControllerPS, which can also be found under the device header of the terminals

  • Fill the NodeRef field with the NodeRef of the terminal that you are linking

  • Keep in mind that the elevator will see the floors in the order in which you add them, so the first one in the list should be the lowest floor

Setting up persistency

• In order for the elevator to be fully functional, the terminals must be set to be persistent

• Do this by checking the Persistentcheckbox of each terminal

Setting up instance data

• In order for each terminal to know which floor marker to use, and what its name is supposed to be, we will use entity instance data

• For each terminal, navigate to:

  • Entity Instance Data / ElevatorFloorTerminalController / persistentState / elevatorFloorSetup

  • In there, set floorDisplayNameto the LocKey that you want to be used as name (E.g. LocKey#49237

  • Set floorMarkerto the NodeRef of the floor's static marker (E.g. $/marker_bottom)

  • Optionally, use the checkboxes under doorShouldOpenFrontLeftRightto determine which doors of the elevator should open on this floor
• Optionally change the elevator speed and inital starting floor by modifying:

  • Entity Instance Data / LiftController / persistentState / liftSetup

Finishing up

• Let's recap what you should have now:

  • A elevator, spawned as Device, with its own NodeRef, and linked to both terminals (Make sure you use the terminals NodeRefs, not the markers)

  • Two terminals, spawned as Device, set to be persistent, with their own NodeRefs, and properly setup instance data (Linking them to the floor markers and with names)

  • Two static markers, each with their own NodeRef, positioned correctly

• Once you have all this, you are ready to export

• Import into WKit

Usage

• Security areas serve two main purposes:

  • Makes the minimap say "Safe/Restricted/Hostile"

  • As an area in which specific player actions alert connected hostiles, as well as providing connectivity between devices and community NPCs (Such that pinging one enemy / device pings all devices and NPCs)

Requirements

Tools

Knowledge

• You need to have a basic understanding of:

  • Working with WolvenKit

Spawning the nodes

• In order to have a functional security area, you need two things:

  • A security system, linked to the security area

  • A security area, defining the area outline and type

• Security system:

  • Spawn a base\gameplay\devices\security_systems\security_system.ent

  • Assign a unique NodeRef

• Security area:

  • Spawn a base\gameplay\devices\security_systems\security_area\security_area_1.ent

  • Assign a unique NodeRef

  • Ensure that it has no rotation, so set roll, pitch and yaw to 0

Linking the devices

• Next we need to link the security system to the area

• To do this, we will go to the Device -> Device Connections header of the security system, add a new entry

• Fill the device class name field (On the left), with the device class name of the security area

  • In our case this would be SecurityAreaControllerPS, which can also be found under the device header of the security area

• Select the NodeRef of the security area on the right hand side of the entry

Creating the outline

• Next we want to create the outline of the security area

• Next, press the Copy outline to clipboard button, found in the Dummy Area

Setting the outline

• Now, we want our security area device to use our previously defined (And copied to clipboard) area outline

• Open the Entity Instance Data header of the security area

• Locate the area component, and expand it

• Right-click the outline header, and select Paste outline [Number of outline markers]

Setting area type

• By default, the area will be Hostile

• To change this, under the entity instance data header, locate:

  • controller -> persistentState -> securityAreaType

  • There you can select the type of area you want

Recap

• You should now have:

  • A security system and security area, spawned as device

  • Both have unique NodeRefs

  • Security system has a device connection to the security area

  • Dummy outline, copy pasted the outline into the security area

Requirements

Tools

Knowledge

• You need to have a basic understanding of:

  • Working with WolvenKit

  • Creating tweaks using TweakXL (.yamlfiles)

TweakXL Setup

• This means you will need to create a custom record using TweakXL

• The below snippet contains the definition for a new one:

• Place it in a new .yamlfile inside Cyberpunk 2077\r6\tweaks

• Modify the snippet for your custom FT point (Especially change the name of the record to something unique, e.g. FastTravelPoints.NAMEOFTHELOCATION)

Spawning Nodes

• In order to have a working FT point you need two nodes:

  • worldEntityNode, the terminal itself

  • worldStaticMarkerNode, location where the player gets teleported to (Any other type of node technically works too)

FT Point

• We will use base\gameplay\devices\fast_travel\data_term_1.ent, you can find it under Entity -> Entity Templatein Object Spawner

• Optionally choose a appearance

Static Marker

• Spawn a static marker, you can find it under Meta -> Static Markerin Object Spawner

• Place it in a fitting spot in front of the terminal

• Assign a custom NodeRef to the static marker:

  • In the properties section, inside the World Nodeheader

  • Make sure the NodeRef is unique

  • E.g. $/ft/custom/marker

Setting up instance data

• In order to tell the FT Point what marker to use, and what record to use, we will use entity instance data

• Open the Entity Instance Dataheader of the FT Terminal

• Expand the entry DataTerm | Entity

  • Locate and expand the linkedFastTravelPointheader

  • Set markerRefto the NodeRef of the marker ($/ft/custom/marker)

  • Set pointRecordto the custom FastTravelPointsrecord (FastTravelPoints.customPoint)

Finishing up

• You should now have the following:

  • A .yamltweak file containing the custom FastTravelPointsrecord

• An Object Spawner group containing:

  • The fast travel terminal entity node, with entity instance data linking it to the marker and the custom record

  • The marker node, with a custom NodeRef assigned