UInkList Class Reference

Allows reading ink lists. More...

#include <InkList.h>

Inheritance diagram for UInkList:

Public Member Functions
bool	IsValid () const
	Returns whether this list object still points to valid runner memory.
bool	ContainsFlag (const FString &flag_name) const
	Checks if a flag is contained (by name).
bool	ContainsEnum (const UEnum *Enum, const uint8 &value) const
	checks if flag with the same spelling then the enum value is set in the list
TArray< uint8 >	ElementsOf (const UEnum *Enum) const
	returns all values of a list with the same name as the enum
TArray< FString >	ElementsOfAsString (const UEnum *Enum) const
	returns all flag as string contained in the list from a list with the same name as the Enum
TArray< FListFlag >	Elements () const
	returns all list_name flag_name tuples
bool	ContainsList (const FString &ListName) const
	check if at least one value of the given list is included, OR the list is empty and associated with the list

Friends
struct	FInkVar

Detailed Description

Allows reading ink lists.

A UInkList wraps a pointer into runner-owned memory. It is only valid until the runner advances (i.e. until the next getline() or choose()). After that IsValid() returns false and all accessor methods become no-ops that return empty/default values. Always check IsValid() before using a list that was not obtained in the same Blueprint event.

Member Function Documentation

ContainsEnum()

bool UInkList::ContainsEnum	(	const UEnum *	Enum,
		const uint8 &	value ) const

checks if flag with the same spelling then the enum value is set in the list

Return values

true	if flag is contained in list
false	if the list is no longer valid

Contains Enum

Target

Enum

Select Asset

Value

Return Value

ContainsFlag()

bool UInkList::ContainsFlag

(

const FString &

flag_name

)

const

Checks if a flag is contained (by name).

Attention

If the flag name is not unique please use the full flag name aka list_name.flag_name

Return values

false

if the list is no longer valid

Contains Flag

Target

Flag name

Return Value

ContainsList()

bool UInkList::ContainsList

(

const FString &

ListName

)

const

check if at least one value of the given list is included, OR the list is empty and associated with the list

Return values

false

if the list is no longer valid

Contains List

Target

List Name

Return Value

Elements()

TArray< FListFlag > UInkList::Elements

(

)

const

returns all list_name flag_name tuples

Return values

empty

array if the list is no longer valid

Elements

Target

Return Value

ElementsOf()

TArray< uint8 > UInkList::ElementsOf

(

const UEnum *

Enum

)

const

returns all values of a list with the same name as the enum

Return values

empty

array if the list is no longer valid

Elements Of

Target

Enum

Select Asset

Return Value

ElementsOfAsString()

TArray< FString > UInkList::ElementsOfAsString

(

const UEnum *

Enum

)

const

returns all flag as string contained in the list from a list with the same name as the Enum

Return values

empty

array if the list is no longer valid

Elements Of As String

Target

Enum

Select Asset

Return Value

IsValid()

bool UInkList::IsValid ( ) const

inline

Returns whether this list object still points to valid runner memory.

A list becomes invalid once the runner advances past the line or variable read that produced it. Do not call any other methods on an invalid list.

Is Valid

Target

Return Value

---

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

• unreal/inkcpp/Source/inkcpp/Public/InkList.h