UDocumentSegment Class Reference

Public Member Functions
Functions
UDocumentElementQuote	AddQuote (FText QuoteText, FText QuoteSource)
UDocumentElementChapterHeading	AddChapterHeading (FText Text)
UDocumentElementEnumeratedList	AddEnumeratedListEntry (FText Text)
UDocumentElementImage	AddImage (TSoftObjectPtr< UTexture2D > Image, FText ImageCaptionText)
UDocumentElementPageBreak	AddPageBreak ()
UDocumentElementParagraph	AddParagraph (FText Text)
UDocumentElementBulletList	AddBulletListEntry (FText Text)
UDocumentElementSectionHeading	AddSectionHeading (FText Text)
void	NotifyShownToReader (const AGothicCharacterState Reader)
	Called on any time time this segment is being viewed by the reader.
void	NotifyShownToReaderFirstTime (const AGothicCharacterState Reader)
	Called on the first time this segment is being viewed by the reader.
bool	PassesUnlockConditions (const AGothicCharacterState Reader) const
	When this segment is requested to be unlocked, you can return false here to block the unlock.
void	BuildSegment (const AGothicCharacterState Reader)
	Called when this Segment is about to be shown to the player. Override and add headings, paragraphs, lists, etc. Here to the Contents-array.
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Public Attributes
DocumentSegment
TSubclassOf< UDocument >	InDocument
	To which Document this Segment belongs.
TArray< FName >	AutoEvaluateUnlockFor
	Character UniqueNames for which this Segment should be evaluated for AutoUnlock whenever something happens to them. If empty, the unlocks must be done manually via explicit function calls.
TArray< UDocumentElement >	Contents
	All added sections that form the content of this page.
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Member Function Documentation

AddBulletListEntry()

UDocumentElementBulletList AddBulletListEntry

(

FText

Text

)

AddChapterHeading()

UDocumentElementChapterHeading AddChapterHeading

(

FText

Text

)

AddEnumeratedListEntry()

UDocumentElementEnumeratedList AddEnumeratedListEntry

(

FText

Text

)

AddImage()

UDocumentElementImage AddImage	(	TSoftObjectPtr< UTexture2D >	Image,
		FText	ImageCaptionText )

AddPageBreak()

UDocumentElementPageBreak AddPageBreak

(

)

AddParagraph()

UDocumentElementParagraph AddParagraph

(

FText

Text

)

AddQuote()

UDocumentElementQuote AddQuote	(	FText	QuoteText,
		FText	QuoteSource )

AddSectionHeading()

UDocumentElementSectionHeading AddSectionHeading

(

FText

Text

)

BuildSegment()

void BuildSegment

(

const AGothicCharacterState

Reader

)

Called when this Segment is about to be shown to the player. Override and add headings, paragraphs, lists, etc. Here to the Contents-array.

NotifyShownToReader()

void NotifyShownToReader

(

const AGothicCharacterState

Reader

)

Called on any time time this segment is being viewed by the reader.

NotifyShownToReaderFirstTime()

void NotifyShownToReaderFirstTime

(

const AGothicCharacterState

Reader

)

Called on the first time this segment is being viewed by the reader.

PassesUnlockConditions()

bool PassesUnlockConditions

(

const AGothicCharacterState

Reader

)

const

When this segment is requested to be unlocked, you can return false here to block the unlock.

StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

AutoEvaluateUnlockFor

TArray<FName> AutoEvaluateUnlockFor

Character UniqueNames for which this Segment should be evaluated for AutoUnlock whenever something happens to them. If empty, the unlocks must be done manually via explicit function calls.

Contents

TArray<UDocumentElement> Contents

All added sections that form the content of this page.

InDocument

TSubclassOf<UDocument> InDocument

To which Document this Segment belongs.