SwitchState¶

struct SwitchState

A switch state.

A switch state is a single state that can be applied to a SwitchContainer to control which sounds are played. Only one state can be active at a time in the same Switch asset.

See: Switch, SwitchContainer

Variables¶

Name	Description
m_id	The ID of this switch state.
m_name	The name of this switch state.

Operators¶

Name	Description
operator==	Compares this switch state with another one for equality.
operator!=	Compares this switch state with another one for inequality.

Functions¶

Name	Description
Valid	Checks whether this switch state is valid.

Variable Details¶

m_id ¶

AmObjectID m_id

The ID of this switch state.

This ID is unique only in the parent switch.

m_name ¶

AmString m_name

The name of this switch state.

Operator Details¶

operator!=¶

bool operator!=(const SwitchState& other) const

Compares this switch state with another one for inequality.

Parameter other: The other switch state to compare with.
Return: true if the switch states are not equal, false otherwise.

operator==¶

bool operator==(const SwitchState& other) const

Compares this switch state with another one for equality.

Parameter [im]: other The other switch state to compare with.
Return: true if the switch states are equal, false otherwise.

Function Details¶

Valid ¶

[[nodiscard]] bool Valid() const

Checks whether this switch state is valid.

Return: true if the switch state is valid, false otherwise.