Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UWritingDocument
static UClass	StaticClass ()
Static Public Member Functions inherited from UDocument
static TArray< TSubclassOf< UDocumentSegment > >	FindSegmentsUnlockedByReader (const AGothicCharacterState Reader, TSubclassOf< UDocument > DocumentClass)
	Returns all segments that this reader has unlocked (in the order they were unlocked).
static TArray< TSubclassOf< UDocumentSegment > >	FindSegmentsViewedByReader (const AGothicCharacterState Reader, TSubclassOf< UDocument > DocumentClass)
	Returns all segments that this reader has unlocked and viewed before (in the order they were viewed).
static bool	IsAllowedToUnlockSegment (AGothicCharacterState Reader, TSubclassOf< UDocument > DocumentClass, TSubclassOf< UDocumentSegment > SegmentClass)
	Returns true, if the segments conditions allow it to unlock it now.
static bool	IsSegmentUnlockedByReader (const AGothicCharacterState Reader, TSubclassOf< UDocumentSegment > SegmentClass)
	Returns true if the given segment has been unlocked for the given reader.
static void	RememberSegmentUnlocked (AGothicCharacterState Reader, TSubclassOf< UDocument > DocumentClass, TSubclassOf< UDocumentSegment > SegmentClass)
	Lets the given reader remember that they have unlocked a segment. (Will be stored in LongTermMemory).
static void	RememberSegmentViewed (AGothicCharacterState Reader, TSubclassOf< UDocument > DocumentClass, TSubclassOf< UDocumentSegment > SegmentClass)
	Lets the given reader remember that they have viewed a segment. (Will be stored in LongTermMemory).
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Public Attributes
Variables
FOnGlossaryUnseenStateChanged	m_OnUnseenStateChanged
	~End UDocument
Public Attributes inherited from UDocument
TArray< UDocumentSegment >	BuiltSegments
	Most recently built Segments. Initially empty, call BuildDocument() to update.
FText	Title
	Title of this Document.
TMap< FName, FString >	Metadata
	Additional metadata attached to this document.
TArray< TSubclassOf< UDocumentSegment > >	AddedSegments
	Templates of the Segments that have been added to this document so far.
const TArray< UDocumentElement >	ContentOfLastBuild
	Returns all contents that have been added during the last build operation.
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

Glossary Document
TSoftObjectPtr< UTexture2D >	m_BannerImage
	Large banner image shown for this glossary in the glossary UI detail view.
TSubclassOf< UGlossaryCategory >	m_CategoryClass
	The category of this glossary entry.
TArray< TSubclassOf< UGlossarySubcategory > >	m_SubcategoryClasses
	The subcategories of this glossary entry.
int	m_SortOrder
	Sort order of this glossary entry in the glossary UI. Smaller numbers are shown first.
TSoftObjectPtr< UTexture2D >	m_ThumbnailImage
	Small thumbnail image shown for this glossary entry in the glossary UI list.
TArray< FString >	m_InitialSegmentNameCrumbs
	Name crumbs to identify the initial segment of this document.
bool	HasInitialSegment () const
	Returns if the document contains an unlocked initial segment.

Glossary Document\|Category
const FText	CategoryDescription
	Returns the description of the category, if set.
const FText	CategoryDisplayName
	Returns the display name of the category, if set.
const FGameplayTag	CategoryFilterTag
	Returns the filter tag of the category, if set.
const TSoftObjectPtr< UTexture2D >	CategoryIconImage
	Returns a soft object pointer to the icon image of the category, if set.
FGameplayTag	GetCategoryFilterTag () const
	Returns the filter tag of the category, if set.
TSoftObjectPtr< UTexture2D >	GetCategoryIconImage () const
	Returns a soft object pointer to the icon image of the category, if set.
FText	GetCategoryDisplayName () const
	Returns the display name of the category, if set.
FText	GetCategoryDescription () const
	Returns the description of the category, if set.

Additional Inherited Members
Public Member Functions inherited from UDocument
TArray< UDocumentElement >	BuildDocument (const AGothicCharacterState Reader)
	Returns all contents that have been explicitly added or unlocked by the reader so far. After calling this once, the contents can also be queried via GetContentOfLastBuild().
TArray< UDocumentElement >	GetContentOfLastBuild () const
	Returns all contents that have been added during the last build operation.
bool	HasBeenBuilt () const
	Returns true, if this Document has some previously (and usable) built data.
void	NotifyShownToReader (AGothicCharacterState Reader)
	To be called when this document is shown to the reader (in UI).
void	AddSegment (TSubclassOf< UDocumentSegment > SegmentClass)
	Adds the given segment to this document.
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

Member Function Documentation

◆ GetCategoryDescription()

FText GetCategoryDescription ( ) const

Returns the description of the category, if set.

◆ GetCategoryDisplayName()

FText GetCategoryDisplayName ( ) const

Returns the display name of the category, if set.

◆ GetCategoryFilterTag()

FGameplayTag GetCategoryFilterTag ( ) const

Returns the filter tag of the category, if set.

◆ GetCategoryIconImage()

TSoftObjectPtr< UTexture2D > GetCategoryIconImage ( ) const

Returns a soft object pointer to the icon image of the category, if set.

◆ HasInitialSegment()

bool HasInitialSegment ( ) const

Returns if the document contains an unlocked initial segment.

◆ StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

◆ CategoryDescription

const FText CategoryDescription

Returns the description of the category, if set.

◆ CategoryDisplayName

const FText CategoryDisplayName

Returns the display name of the category, if set.

◆ CategoryFilterTag

const FGameplayTag CategoryFilterTag

Returns the filter tag of the category, if set.

◆ CategoryIconImage

const TSoftObjectPtr<UTexture2D> CategoryIconImage

Returns a soft object pointer to the icon image of the category, if set.

◆ m_BannerImage

TSoftObjectPtr<UTexture2D> m_BannerImage

Large banner image shown for this glossary in the glossary UI detail view.

◆ m_CategoryClass

TSubclassOf<UGlossaryCategory> m_CategoryClass

The category of this glossary entry.

◆ m_InitialSegmentNameCrumbs

TArray<FString> m_InitialSegmentNameCrumbs

Name crumbs to identify the initial segment of this document.

◆ m_OnUnseenStateChanged

FOnGlossaryUnseenStateChanged m_OnUnseenStateChanged

~End UDocument

◆ m_SortOrder

int m_SortOrder

Sort order of this glossary entry in the glossary UI. Smaller numbers are shown first.

◆ m_SubcategoryClasses

TArray<TSubclassOf<UGlossarySubcategory> > m_SubcategoryClasses

The subcategories of this glossary entry.

◆ m_ThumbnailImage

TSoftObjectPtr<UTexture2D> m_ThumbnailImage

Small thumbnail image shown for this glossary entry in the glossary UI list.

Static Public Member Functions

Public Attributes

Glossary Document

Glossary Document|Category

Additional Inherited Members