FSubjectNetworkState Struct Reference

The internal state of a networked subject. More...

#include <SubjectInfo.h>

Public Types
using	IdType = SubjectNetworkIdType
	The type of a networked identifier.

Public Member Functions
const FTraitmark &	GetTraitmarkPermit () const
	The traits allowed to be pushed to this subject's server version.
template<EParadigm Paradigm = EParadigm::Default>
TOutcome< Paradigm >	SetTraitmarkPermit (const FTraitmark &InTraitmarkPermit)
	Set the server-side list of traits allowed to be pushed from clients.
UNetConnection *	GetConnectionPermit () const
	Get the connection allowed to push to this subject on the server.
EApparatusStatus	SetConnectionPermit (UNetConnection *const InConnection)
	Set the client connection allowed to push to this subject on the server.
uint32	GetId () const
	Get the universal network identifier.
FSubjectInfo::IdType	GetSubjectId () const
	Get the subject identifier.
bool	IsValid () const
	Check if this network information is actually valid.

Static Public Attributes
static constexpr IdType	InvalidId = 0x0
	Invalid network identifier.
static constexpr IdType	FirstId = 0x1
	A first valid network identifier.
static constexpr IdType	LastId = TNumericLimits<IdType>::Max() - 1
	The maximum network identifier possible to be allocated.

Friends
struct	FSubjectInfo
struct	FSubjectRecord
class	ISubjective
class	ASubjectiveActor
class	USubjectiveActorComponent
class	UNetworkBearerComponent
class	AMechanism
class	UMachine

Detailed Description

The internal state of a networked subject.

Member Typedef Documentation

IdType

using FSubjectNetworkState::IdType = SubjectNetworkIdType

The type of a networked identifier.

Member Function Documentation

GetConnectionPermit()

UNetConnection * FSubjectNetworkState::GetConnectionPermit ( ) const

inline

Get the connection allowed to push to this subject on the server.

GetId()

uint32 FSubjectNetworkState::GetId ( ) const

inline

Get the universal network identifier.

GetSubjectId()

FSubjectInfo::IdType FSubjectNetworkState::GetSubjectId ( ) const

inline

Get the subject identifier.

GetTraitmarkPermit()

const FTraitmark & FSubjectNetworkState::GetTraitmarkPermit ( ) const

inline

The traits allowed to be pushed to this subject's server version.

IsValid()

bool FSubjectNetworkState::IsValid ( ) const

inline

Check if this network information is actually valid.

SetConnectionPermit()

EApparatusStatus FSubjectNetworkState::SetConnectionPermit ( UNetConnection *const  InConnection )

inline

Set the client connection allowed to push to this subject on the server.

Parameters

InConnection

The connection to set to.

Returns

The status of the operation.

SetTraitmarkPermit()

template<EParadigm Paradigm = EParadigm::Default>

TOutcome< Paradigm > FSubjectNetworkState::SetTraitmarkPermit ( const FTraitmark &  InTraitmarkPermit )

inline

Set the server-side list of traits allowed to be pushed from clients.

Template Parameters

Paradigm

The paradigm to work under.

Parameters

[in]

InTraitmarkPermit

The traitmark permit to set.

Returns

The status of the operation.

Friends And Related Function Documentation

AMechanism

friend class AMechanism

friend

ASubjectiveActor

friend class ASubjectiveActor

friend

FSubjectInfo

friend struct FSubjectInfo

friend

FSubjectRecord

friend struct FSubjectRecord

friend

ISubjective

friend class ISubjective

friend

UMachine

friend class UMachine

friend

UNetworkBearerComponent

friend class UNetworkBearerComponent

friend

USubjectiveActorComponent

friend class USubjectiveActorComponent

friend

Member Data Documentation

FirstId

constexpr IdType FSubjectNetworkState::FirstId = 0x1

staticconstexpr

A first valid network identifier.

InvalidId

constexpr IdType FSubjectNetworkState::InvalidId = 0x0

staticconstexpr

Invalid network identifier.

LastId

constexpr IdType FSubjectNetworkState::LastId = TNumericLimits<IdType>::Max() - 1

staticconstexpr

The maximum network identifier possible to be allocated.

---

The documentation for this struct was generated from the following file:

• SubjectInfo.h