FCBP_Room

One room type inside a cluster. Used in the array of FCBP_Cluster.roomDescriptions(...).

Setters

Setter Effect
mainTag(FName) Tag identifying this room type.
count(uint8) How many rooms of this type to generate.
stairHeightInMeter(float) Step height of generated stairs, in meters. Default 0.2.
isPlayerStartPoint(bool) When true, the player(s) spawn in this room.
isPlayerCoursePoint(bool) When true, the room is a waypoint on the player’s course.
minSizeMeter(float) Minimum room size, in meters.
maxSizeMeter(float) Maximum room size, in meters.
marginMeter(float) Margin kept around the room, in meters.
interaction(FCBP_RoomInteraction) Room interaction → FCBP_RoomInteraction.
npcs(TArray<FCBP_ACPRoomRule>) NPC assignment rules → FCBP_ACPRoomRule.

The hook onSpawnCondition is a skill, documented in the Skills section.

Example

FCBP_Room room = FCBP_Room()
    .mainTag("BOSS_ROOM")
    .count(1)
    .stairHeightInMeter(0.2f)
    .isPlayerStartPoint(true)
    .isPlayerCoursePoint(false)
    .minSizeMeter(10.0f)
    .maxSizeMeter(15.0f)
    .marginMeter(3.0f)
    .interaction(FCBP_RoomInteraction()
        .interactWithPlayerOnly(true))
    .npcs({ FCBP_ACPRoomRule()
        .npcTag("SPIDER")
        .count(2) });