Dungeon Generator  1.6.6
Procedural 3D dungeon generator plugin for Unreal Engine 5. Easy generation of levels, mini-maps and missions.
Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
UDungeonGenerateParameter Class Reference

#include <DungeonGenerateParameter.h>

Inheritance diagram for UDungeonGenerateParameter:

Public Member Functions

 UDungeonGenerateParameter (const FObjectInitializer &ObjectInitializer)
 
virtual ~UDungeonGenerateParameter () override=default
 
int32 GetRandomSeed () const
 
int32 GetGeneratedRandomSeed () const
 
int32 GetNumberOfCandidateRooms () const
 
const FInt32Interval & GetRoomWidth () const noexcept
 
const FInt32Interval & GetRoomDepth () const noexcept
 
const FInt32Interval & GetRoomHeight () const noexcept
 
int32 GetHorizontalRoomMargin () const noexcept
 
int32 GetVerticalRoomMargin () const noexcept
 
FDungeonGridSize GetGridSize () const
 
bool IsMergeRooms () const noexcept
 
bool IsMovePlayerStartToStartingPoint () const noexcept
 
bool IsUseMissionGraph () const noexcept
 
uint8 GetAisleComplexity () const noexcept
 
bool IsAisleComplexity () const noexcept
 
EFrequencyOfGeneration GetFrequencyOfTorchlightGeneration () const noexcept
 
const FDungeonRoomRegister * GetStartRoom () const
 
const FDungeonRoomRegister * GetGoalRoom () const
 
int32 GetDungeonRoomRegisterCount () const
 
const FDungeonRoomRegister * FindDungeonRoomRegister (const uint32_t reservationNumber) const
 
void EachDungeonRoomRegister (const std::function< bool(const FDungeonRoomRegister &)> &function) const
 
void EachDungeonRoomLocator (const std::function< bool(const FDungeonRoomLocator &)> &function) const
 
int32 GetDungeonRoomLocatorMaxDrawCount () const
 
UClass * GetRoomSensorClass () const
 
UDungeonRoomSensorDatabase * GetRoomSensorDatabase () const
 
FVector ToWorld (const FIntVector &location) const
 
FVector ToWorld (const uint32_t x, const uint32_t y, const uint32_t z) const
 
FIntVector ToGrid (const FVector &location) const
 
void SetRandomParameter () noexcept
 
virtual void GetLifetimeReplicatedProps (TArray< FLifetimeProperty > &OutLifetimeProps) const override
 
virtual bool IsSupportedForNetworking () const override
 
virtual void PostLoad () override
 

Static Public Member Functions

static UDungeonGenerateParameter * GenerateRandomParameter (const UDungeonGenerateParameter *sourceParameter) noexcept
 

Protected Attributes

int32 RandomSeed = 0
 
int32 GeneratedRandomSeed = 0
 
int32 GeneratedDungeonCRC32 = 0
 
FInt32Interval RoomWidth = { 3, 8 }
 
FInt32Interval RoomDepth = { 3, 8 }
 
FInt32Interval RoomHeight = { 2, 4 }
 
uint8 RoomMargin = 2
 
uint8 VerticalRoomMargin = 0
 
uint8 NumberOfCandidateRooms = 10
 
bool MergeRooms = false
 
EDungeonExpansionPolicy ExpansionPolicy = EDungeonExpansionPolicy::ExpandHorizontally
 
uint8 NumberOfCandidateFloors = 3
 
bool Flat = false
 
bool MovePlayerStartToStartingPoint = true
 
EDungeonStartLocationPolicy StartLocationPolicy = EDungeonStartLocationPolicy::UseSouthernMost
 
bool UseMissionGraph = false
 
uint8 AisleComplexity = 5
 
bool GenerateSlopeInRoom = false
 
bool GenerateStructuralColumn = false
 
float GridSize = 400.f
 
float VerticalGridSize = 400.f
 
TObjectPtr< UDungeonMeshSetDatabase > DungeonRoomMeshPartsDatabase
 
TObjectPtr< UDungeonMeshSetDatabase > DungeonAisleMeshPartsDatabase
 
EDungeonPartsSelectionMethod PillarPartsSelectionMethod = EDungeonPartsSelectionMethod::Random
 
TArray< FDungeonMeshParts > PillarParts
 
EDungeonPartsSelectionMethod TorchPartsSelectionMethod = EDungeonPartsSelectionMethod::Random
 
EFrequencyOfGeneration FrequencyOfTorchlightGeneration = EFrequencyOfGeneration::Rarely
 
TArray< FDungeonRandomActorParts > TorchParts
 
EDungeonPartsSelectionMethod DoorPartsSelectionMethod = EDungeonPartsSelectionMethod::Random
 
TArray< FDungeonDoorActorParts > DoorParts
 
TObjectPtr< UDungeonInteriorDatabase > DungeonInteriorDatabase
 
TObjectPtr< UDungeonSubLevelDatabase > DungeonSubLevelDatabase
 
TObjectPtr< UClass > DungeonRoomSensorClass
 
TObjectPtr< UDungeonRoomSensorDatabase > DungeonRoomSensorDatabase
 
uint8 PluginVersion
 

Friends

class ADungeonGenerateBase
 
class ADungeonGenerateActor
 

Detailed Description

Dungeon generation parameter ダンジョン生成パラメータ

Constructor & Destructor Documentation

◆ UDungeonGenerateParameter()

UDungeonGenerateParameter::UDungeonGenerateParameter ( const FObjectInitializer &  ObjectInitializer)
explicit

コンストラクタ

Author
Shun Moriya
Copyright
2023- Shun Moriya All Rights Reserved.

◆ ~UDungeonGenerateParameter()

virtual UDungeonGenerateParameter::~UDungeonGenerateParameter ( )
overridevirtualdefault

デストラクタ

Member Function Documentation

◆ EachDungeonRoomLocator()

void UDungeonGenerateParameter::EachDungeonRoomLocator ( const std::function< bool(const FDungeonRoomLocator &)> &  function) const

抽選して生成するサブレベルの設定を更新します

◆ EachDungeonRoomRegister()

void UDungeonGenerateParameter::EachDungeonRoomRegister ( const std::function< bool(const FDungeonRoomRegister &)> &  function) const

必ず生成するサブレベルの設定を更新します

◆ FindDungeonRoomRegister()

const FDungeonRoomRegister * UDungeonGenerateParameter::FindDungeonRoomRegister ( const uint32_t  reservationNumber) const

予約番号から必ず生成するサブレベルの設定を検索します

◆ GenerateRandomParameter()

UDungeonGenerateParameter * UDungeonGenerateParameter::GenerateRandomParameter ( const UDungeonGenerateParameter *  sourceParameter)
staticnoexcept

ランダムなダンジョンのパラメータを生成します

Parameters
sourceParameterコピー元パラメータ（メッシュ等の設定をコピーします）
Returns
DungeonGenerateParameter

◆ GetAisleComplexity()

uint8 UDungeonGenerateParameter::GetAisleComplexity ( ) const
inlinenoexcept

通路の複雑度を取得します

◆ GetDungeonRoomLocatorMaxDrawCount()

int32 UDungeonGenerateParameter::GetDungeonRoomLocatorMaxDrawCount ( ) const

生成するサブレベルの最大抽選数を取得します

◆ GetDungeonRoomRegisterCount()

int32 UDungeonGenerateParameter::GetDungeonRoomRegisterCount ( ) const

必ず生成するサブレベルの数を取得します

◆ GetFrequencyOfTorchlightGeneration()

EFrequencyOfGeneration UDungeonGenerateParameter::GetFrequencyOfTorchlightGeneration ( ) const
inlinenoexcept

燭台アクターの生成頻度を取得します

◆ GetGeneratedRandomSeed()

int32 UDungeonGenerateParameter::GetGeneratedRandomSeed ( ) const
inline

ダンジョン生成に使用した乱数の種を取得します

◆ GetGoalRoom()

const FDungeonRoomRegister * UDungeonGenerateParameter::GetGoalRoom ( ) const

ゴール部屋の設定を取得します

◆ GetGridSize()

FDungeonGridSize UDungeonGenerateParameter::GetGridSize ( ) const
inline

グリッドのサイズを取得します

◆ GetHorizontalRoomMargin()

int32 UDungeonGenerateParameter::GetHorizontalRoomMargin ( ) const
inlinenoexcept

部屋と部屋の水平方向の間隔（余白）を取得します

◆ GetNumberOfCandidateRooms()

int32 UDungeonGenerateParameter::GetNumberOfCandidateRooms ( ) const
inline

生成する部屋の候補数を取得します

◆ GetRandomSeed()

int32 UDungeonGenerateParameter::GetRandomSeed ( ) const
inline

ダンジョン生成に使用する乱数の種を取得します

◆ GetRoomDepth()

const FInt32Interval & UDungeonGenerateParameter::GetRoomDepth ( ) const
inlinenoexcept

部屋の奥行を取得します

◆ GetRoomHeight()

const FInt32Interval & UDungeonGenerateParameter::GetRoomHeight ( ) const
inlinenoexcept

部屋の高さを取得します

◆ GetRoomSensorClass()

UClass * UDungeonGenerateParameter::GetRoomSensorClass ( ) const
inline

DungeonRoomSensorのクラスを取得します

◆ GetRoomSensorDatabase()

UDungeonRoomSensorDatabase * UDungeonGenerateParameter::GetRoomSensorDatabase ( ) const
inline

DungeonRoomSensorのデータベースを取得します

◆ GetRoomWidth()

const FInt32Interval & UDungeonGenerateParameter::GetRoomWidth ( ) const
inlinenoexcept

部屋の幅を取得します

◆ GetStartRoom()

const FDungeonRoomRegister * UDungeonGenerateParameter::GetStartRoom ( ) const

スタート部屋の設定を取得します

◆ GetVerticalRoomMargin()

int32 UDungeonGenerateParameter::GetVerticalRoomMargin ( ) const
inlinenoexcept

部屋と部屋の垂直方向の間隔（余白）を取得します

◆ IsAisleComplexity()

bool UDungeonGenerateParameter::IsAisleComplexity ( ) const
inlinenoexcept

通路の複雑度が有効か？取得します

◆ IsMergeRooms()

bool UDungeonGenerateParameter::IsMergeRooms ( ) const
inlinenoexcept

部屋と部屋を結合するか取得します

◆ IsMovePlayerStartToStartingPoint()

bool UDungeonGenerateParameter::IsMovePlayerStartToStartingPoint ( ) const
inlinenoexcept

ゲーム開始時にPlayerStartアクターを移動するか？取得します

◆ IsUseMissionGraph()

bool UDungeonGenerateParameter::IsUseMissionGraph ( ) const
inlinenoexcept

ミッショングラフを有効にするか取得します

◆ SetRandomParameter()

void UDungeonGenerateParameter::SetRandomParameter ( )
noexcept

ランダムなダンジョンのパラメータにリセットします

◆ ToGrid()

FIntVector UDungeonGenerateParameter::ToGrid ( const FVector &  location) const

Converts from a grid coordinate system to a world coordinate system

グリッド座標系からワールド座標系への変換

◆ ToWorld() [1/2]

FVector UDungeonGenerateParameter::ToWorld ( const FIntVector &  location) const

Converts from a grid coordinate system to a world coordinate system

グリッド座標系からワールド座標系への変換

◆ ToWorld() [2/2]

FVector UDungeonGenerateParameter::ToWorld ( const uint32_t  x,
const uint32_t  y,
const uint32_t  z 
) const

Converts from a grid coordinate system to a world coordinate system

グリッド座標系からワールド座標系への変換

Member Data Documentation

◆ AisleComplexity

uint8 UDungeonGenerateParameter::AisleComplexity = 5
protected

Aisle complexity (0 being the minimum aisle) MergeRooms and UseMissionGraph must be unchecked to enable AisleComplexity

通路の複雑さ（０が最低限の通路） AisleComplexityを有効にするには、MergeRoomsとUseMissionGraphのチェックを外す必要があります

◆ DoorParts

TArray<FDungeonDoorActorParts> UDungeonGenerateParameter::DoorParts
protected

Door Parts

ドアのメッシュパーツデータベース

◆ DoorPartsSelectionMethod

EDungeonPartsSelectionMethod UDungeonGenerateParameter::DoorPartsSelectionMethod = EDungeonPartsSelectionMethod::Random
protected

How to generate door parts

ドアのパーツを生成する方法

◆ DungeonAisleMeshPartsDatabase

TObjectPtr<UDungeonMeshSetDatabase> UDungeonGenerateParameter::DungeonAisleMeshPartsDatabase
protected

Aisle mesh parts database

通路のメッシュパーツデータベース

◆ DungeonInteriorDatabase

TObjectPtr<UDungeonInteriorDatabase> UDungeonGenerateParameter::DungeonInteriorDatabase
protected

Interior asset database

インテリアアセットのデータベースを指定して下さい。

◆ DungeonRoomMeshPartsDatabase

TObjectPtr<UDungeonMeshSetDatabase> UDungeonGenerateParameter::DungeonRoomMeshPartsDatabase
protected

Room mesh parts database

部屋のメッシュパーツデータベース

◆ DungeonRoomSensorClass

TObjectPtr<UClass> UDungeonGenerateParameter::DungeonRoomSensorClass
protected

Specify the DungeonRoomSensorBase class, which is a box sensor that covers the room and controls doors and enemy spawn. DungeonRoomSensorDatabase takes precedence

DungeonRoomSensorBaseクラスを指定して下さい。 DungeonRoomSensorBaseは部屋を覆う箱センサーで、ドアや敵のスポーンを制御します。 DungeonRoomSensorDatabaseが優先されます

◆ DungeonRoomSensorDatabase

TObjectPtr<UDungeonRoomSensorDatabase> UDungeonGenerateParameter::DungeonRoomSensorDatabase
protected

Specify the room sensor database The room sensor database specifies the arrangement and direction in the room

ルームセンサーのデータベースを指定して下さい ルームセンサーのデータベースは部屋の中の配置や演出を指定します

◆ DungeonSubLevelDatabase

TObjectPtr<UDungeonSubLevelDatabase> UDungeonGenerateParameter::DungeonSubLevelDatabase
protected

Specify the sublevel database. The sublevel database is the designation of the start and goal rooms and sublevels.

サブレベルのデータベースを指定して下さい。 サブレベルのデータベースはスタート部屋やゴール部屋、サブレベルの指定です。

◆ ExpansionPolicy

EDungeonExpansionPolicy UDungeonGenerateParameter::ExpansionPolicy = EDungeonExpansionPolicy::ExpandHorizontally
protected

Defines the direction in which rooms expand during dungeon generation. Each value influences room proliferation logic and is used to control the dungeon's structure (tall, wide, or mixed).

ダンジョン生成時に部屋をどの方向へ展開するかを定義します。 各値は部屋の増殖ロジックに影響し、ダンジョンの構造（縦長・横長・混在）を コントロールするために使用されます。

◆ Flat

bool UDungeonGenerateParameter::Flat = false
protected

Generates a flat dungeon

平面的なダンジョンを生成します

◆ FrequencyOfTorchlightGeneration

EFrequencyOfGeneration UDungeonGenerateParameter::FrequencyOfTorchlightGeneration = EFrequencyOfGeneration::Rarely
protected

Frequency of torchlight generation

燭台の生成頻度

◆ GeneratedDungeonCRC32

int32 UDungeonGenerateParameter::GeneratedDungeonCRC32 = 0
protected

CRC32 of the last dungeon generated

最後に生成されたダンジョンのCRC32

◆ GeneratedRandomSeed

int32 UDungeonGenerateParameter::GeneratedRandomSeed = 0
protected

Seed of random numbers used for the last generation

最後の生成に使用された乱数のシード

◆ GenerateSlopeInRoom

bool UDungeonGenerateParameter::GenerateSlopeInRoom = false
protected

Generate slopes in the room. May be enabled by future forcing.

部屋の中にスロープを生成する 将来的強制的に有効になる可能性があります。

◆ GenerateStructuralColumn

bool UDungeonGenerateParameter::GenerateStructuralColumn = false
protected

Generate structural columns in the room May be enabled by future forcing.

部屋の中に構造柱を生成する 将来的強制的に有効になる可能性があります。

◆ GridSize

float UDungeonGenerateParameter::GridSize = 400.f
protected

Horizontal voxel size

水平方向のボクセルサイズ

◆ MergeRooms

bool UDungeonGenerateParameter::MergeRooms = false
protected

Horizontal room-to-room coupling

有効にすると部屋と部屋を結合します

◆ MovePlayerStartToStartingPoint

bool UDungeonGenerateParameter::MovePlayerStartToStartingPoint = true
protected

PlayerStart is automatically moved to the start room at the start

開始時にPlayerStartを自動的にスタート部屋に移動します

◆ NumberOfCandidateFloors

uint8 UDungeonGenerateParameter::NumberOfCandidateFloors = 3
protected

Candidate Number of Generated Hierarchies This is used as a reference number of hierarchies for generation, not as the final number of hierarchies.

生成される階層数の候補 これは最終的な階層の数ではなく生成時の参考階層数として利用されます。

◆ NumberOfCandidateRooms

uint8 UDungeonGenerateParameter::NumberOfCandidateRooms = 10
protected

Candidate number of rooms to be generated This is the initial number of rooms to be generated, not the final number of rooms to be generated.

生成される部屋数の候補 これは最終的な部屋の数ではなく最初に生成される部屋の数です

◆ PillarParts

TArray<FDungeonMeshParts> UDungeonGenerateParameter::PillarParts
protected

Pillar Parts

柱のメッシュパーツデータベース

◆ PillarPartsSelectionMethod

EDungeonPartsSelectionMethod UDungeonGenerateParameter::PillarPartsSelectionMethod = EDungeonPartsSelectionMethod::Random
protected

How to generate parts of pillar

柱のパーツを生成する方法

◆ PluginVersion

uint8 UDungeonGenerateParameter::PluginVersion
protected

PluginVersion

プラグインバージョン

◆ RandomSeed

int32 UDungeonGenerateParameter::RandomSeed = 0
protected

Seed of random number (if 0, auto-generated)

乱数のシード（0なら自動生成）

◆ RoomDepth

FInt32Interval UDungeonGenerateParameter::RoomDepth = { 3, 8 }
protected

Room depth

部屋の奥行き

◆ RoomHeight

FInt32Interval UDungeonGenerateParameter::RoomHeight = { 2, 4 }
protected

Room height

部屋の高さ

◆ RoomMargin

uint8 UDungeonGenerateParameter::RoomMargin = 2
protected

Horizontal room-to-room margins MergeRooms must be unchecked to enable Room Horizontal Margin

水平方向の部屋と部屋の空白 Room Horizontal Marginを有効にするにはMergeRoomsのチェックを外す必要があります

◆ RoomWidth

FInt32Interval UDungeonGenerateParameter::RoomWidth = { 3, 8 }
protected

Room Width

部屋の幅

◆ StartLocationPolicy

EDungeonStartLocationPolicy UDungeonGenerateParameter::StartLocationPolicy = EDungeonStartLocationPolicy::UseSouthernMost
protected

When generating dungeons, this specifies the criteria for selecting the room where the player starts. Each policy makes its determination based on the room's positional information (coordinates or floor level).

ダンジョン生成時に、プレイヤーの開始位置となる部屋を どの基準で選択するかを指定します。各ポリシーは部屋の 位置情報（座標や階層）に基づいて判定を行います。

◆ TorchParts

TArray<FDungeonRandomActorParts> UDungeonGenerateParameter::TorchParts
protected

Torch (pillar lighting) parts

燭台のメッシュパーツデータベース

◆ TorchPartsSelectionMethod

EDungeonPartsSelectionMethod UDungeonGenerateParameter::TorchPartsSelectionMethod = EDungeonPartsSelectionMethod::Random
protected

How to generate parts for torch

燭台のパーツを生成する方法

◆ UseMissionGraph

bool UDungeonGenerateParameter::UseMissionGraph = false
protected

Enable MissionGraph to generate missions with keys. MergeRooms must be unchecked and AisleComplexity must be 0 for UseMissionGraph to be enabled.

MissionGraphを有効にして、鍵を使ったミッション情報を生成します UseMissionGraphを有効にするには、MergeRoomsのチェックを外しAisleComplexityを0にする必要があります

◆ VerticalGridSize

float UDungeonGenerateParameter::VerticalGridSize = 400.f
protected

Vertical voxel size

垂直方向のボクセルサイズ

◆ VerticalRoomMargin

uint8 UDungeonGenerateParameter::VerticalRoomMargin = 0
protected

Vertical room-to-room margins MergeRooms must be unchecked to enable Room Vertical Margin

垂直方向の部屋と部屋の空白 Room Vertical Marginを有効にするにはMergeRoomsのチェックを外す必要があります

The documentation for this class was generated from the following files: