dao::CDataArrays

class

The parameter lists that an effect, an event or a command carries, read and written by index.

Scripts read them with GetEffectInteger, GetEventInteger, GetCommandInt and similar commands.

Declared in dao/Structures.h.

Functions

CDataArrays()

CDataArrays()=delete

CDataArrays()

CDataArrays(const CDataArrays &)=delete

Flag()

std::int32_t Flag(std::int32_t index) const

Returns the flag parameter at an index, or 0 if there is none.

The command constructors store a script’s booleans, such as bRunToLocation and bPlayNext, as flags.

Float()

float Float(std::int32_t index) const

Returns the float parameter at an index, or 0.0 if there is none.

Integer()

std::int32_t Integer(std::int32_t index) const

Returns the integer parameter at an index, or 0 if there is none.

Object()

ObjectId Object(std::int32_t index) const

Returns the object parameter at an index, or kInvalidObject if there is none.

operator=()

CDataArrays & operator=(const CDataArrays &)=delete

SetFlag()

void SetFlag(std::int32_t index, std::int32_t value)

Sets the flag parameter at an index.

SetFloat()

void SetFloat(std::int32_t index, float value)

Sets the float parameter at an index.

SetInteger()

void SetInteger(std::int32_t index, std::int32_t value)

Sets the integer parameter at an index.

A command that has not started yet uses the new value as if its script had passed it. Elsewhere, the effect of a change depends on what reads the value. The same applies to the other setters.

SetObject()

void SetObject(std::int32_t index, ObjectId value)

Sets the object parameter at an index.

SetVector()

void SetVector(std::int32_t index, const ::dao::Vector &value)

Sets the vector parameter at an index.

String()

std::wstring_view String(std::int32_t index) const

Returns the string parameter at an index, or an empty string if there is none.

The view points into the engine’s own string, and is valid only as long as the structure.

Vector()

std::optional<::dao::Vector> Vector(std::int32_t index) const

Returns the vector parameter at an index.

Returns the vector, or nullopt if there is none

~CDataArrays()

~CDataArrays()=delete

VectorList

Fields

Field Type  
capacity std::uint32_t  
data const std::byte *  
size std::uint32_t