Debug functions

Debug functions that are used as command and/or used for the debug tools. More...

Functions
void	DataShardSubsystem::GetShardDump (FString &Out) const
void	DataShardSubsystem::GetShardStringDump (FString &Out) const
void	DataShardSubsystem::GetKeyDump (FString &Out) const
void	DataShardSubsystem::GetRefDump (FString &Out) const
void	DataShardSubsystem::GetShardIDsForObject (const UObject *InObject, TArray< int32 > &OutArray) const
int32	DataShardSubsystem::GetPoolSize () const
int32	DataShardSubsystem::GetActiveShardCount () const
int32	DataShardSubsystem::GetAvailableShardCount () const
FString	DataShardSubsystem::GetDebugDataForShard (const int32 &InID) const
FString	DataShardSubsystem::GetDebugDataForShard (const FDataShardKey &InKey) const
FString	DataShardSubsystem::GetDebugDataForObject (const UObject *InObject) const
static FString	DataShardUtils_BP::ShardDataAsString (const UObject *WorldContextObject, const FDataShardKey &Key)
static FString	DataShardUtils_BP::AllShardDataAsString (const UObject *WorldContextObject, const AActor *Actor)

Detailed Description

Debug functions that are used as command and/or used for the debug tools.

Use this functions only for debgging or logging. They are not for gameplay elements.

Function Documentation

AllShardDataAsString()

static FString DataShardUtils_BP::AllShardDataAsString ( const UObject * WorldContextObject, const AActor * Actor )

static

Converts all DataShards associated with an Actor to a readable string for debugging

Parameters

WorldContextObject	Object that provides access to the world
Actor	Actor whose DataShards should be converted to string

Returns

String representation of all DataShards owned by the Actor

GetActiveShardCount()

int32 DataShardSubsystem::GetActiveShardCount ( ) const

inline

Returns the number of active shards in the pool

GetAvailableShardCount()

int32 DataShardSubsystem::GetAvailableShardCount ( ) const

inline

Returns the number of available (unused) shards in the pool

GetDebugDataForObject()

FString DataShardSubsystem::GetDebugDataForObject

(

const UObject *

InObject

)

const

Gets debug information about all shards associated with an object

Parameters

InObject

- The object to get shard information for

Returns

Formatted string with details about all associated shards

GetDebugDataForShard() [1/2]

FString DataShardSubsystem::GetDebugDataForShard

(

const FDataShardKey &

InKey

)

const

Gets debug information about a shard as a formatted string

Parameters

InKey

- The key of the shard to get information for

Returns

Formatted string with shard details

GetDebugDataForShard() [2/2]

FString DataShardSubsystem::GetDebugDataForShard

(

const int32 &

InID

)

const

Gets debug information about a shard as a formatted string

Parameters

InID	- The ID of the shard to get information for

Returns

Formatted string with shard details

GetKeyDump()

void DataShardSubsystem::GetKeyDump

(

FString &

Out

)

const

Gets a formatted string containing information about all keys in the system

Parameters

Out	- [Out] String that will be filled with the key information

Note

Format: ActorName KeyName -> ShardID

GetPoolSize()

int32 DataShardSubsystem::GetPoolSize ( ) const

inline

Returns the total pool size (active + available shards)

GetRefDump()

void DataShardSubsystem::GetRefDump

(

FString &

Out

)

const

Gets a formatted string listing each shard and its reference count

Parameters

Out	- [Out] String that will be filled with the reference count information

Note

Format: ShardID -> RefNum

GetShardDump()

void DataShardSubsystem::GetShardDump

(

FString &

Out

)

const

Gets a formatted string containing information about all shards in the system

Parameters

Out	- [Out] String that will be filled with the formatted shard information

Note

Format: "Shard ID -> Shard Class"

GetShardIDsForObject()

void DataShardSubsystem::GetShardIDsForObject	(	const UObject *	InObject,
		TArray< int32 > &	OutArray ) const

Retrieves all shard IDs associated with a specific object

Parameters

InObject	- The object to get shard IDs for
OutArray	- [Out] Array that will be appended with the shard IDs

Note

The OutArray is not cleared before adding IDs

GetShardStringDump()

void DataShardSubsystem::GetShardStringDump

(

FString &

Out

)

const

Gets a formatted string containing detailed information about actors and their associated shards

Parameters

Out	- [Out] String that will be filled with the detailed information

Note

Format: Actor: Name Shard Value Shard Value ...

ShardDataAsString()

static FString DataShardUtils_BP::ShardDataAsString ( const UObject * WorldContextObject, const FDataShardKey & Key )

static

Converts the data in a specific DataShard to a readable string for debugging

Parameters

WorldContextObject	Object that provides access to the world
Key	Key to the DataShard to convert to string

Returns

String representation of the DataShard's value, or error message if not found