Jazz2::Editor::EventDescriptor struct

Description of an event, how it's shown and how its parameters are edited.

Public functions

template<std::size_t N>
auto WithPreviewCases(std::int8_t field, const EventPreviewCase(&cases)[N]) const -> EventDescriptor constexpr
Returns the description with the looks for the values of a field, by its index.

Public variables

EventType Type
Type.
const char* Key
Identifier that doesn't change between versions.
const char* Name
Name shown to the user, see CatalogText.
EventCategory Category
Category.
const char* Description
Description, see CatalogText, may be nullptr.
const EventParamField* Fields
Parameters.
std::uint8_t FieldCount
Number of parameters.
const char* PreviewMetadata
Path of the metadata the event is previewed with, nullptr to show it as a box.
std::uint32_t PreviewAnimation
Animation of the metadata the event is previewed with (see AnimState).
EventTraits Traits
What the event is.
const EventPreviewCase* PreviewCases
How the event looks by the value of one of its parameters, nullptr to look as PreviewMetadata says.
std::uint8_t PreviewCaseCount
Number of PreviewCases.
std::int8_t PreviewField
Index of the field PreviewCases are chosen by, -1 for none.
std::uint8_t OriginalEvent
Number of the event of the original game it describes, which EventType::PassthroughEvent keeps, 0 for none.

Variable documentation

const EventPreviewCase* Jazz2::Editor::EventDescriptor::PreviewCases

How the event looks by the value of one of its parameters, nullptr to look as PreviewMetadata says.

The case of the value of the field PreviewField is taken, or the one for EventPreviewCase::AnyValue, or PreviewMetadata if there's neither. Without a field (-1), the case for any value is taken.