SwitchContainerItem¶
struct SwitchContainerItem
Describes a single item within a SwitchContainer.
- See
- SwitchContainer
Variables¶
| Name | Description |
|---|---|
| m_id | The object ID of the item. |
| m_continueBetweenStates | Whether to continue playing this item when the SwitchContainer * changes its state between one of the values where this item is registered. |
| m_fadeInDuration | The fade duration in milliseconds when this item starts playing. |
| m_fadeInAlgorithm | The name of the fading algorithm to use when this item starts playing. |
| m_fadeOutDuration | The fade duration in milliseconds when this item stops playing. |
| m_fadeOutAlgorithm | The name of the fading algorithm to use when this item stops playing. |
| m_gain | The custom linear gain applied on this item. |
| m_pitch | The custom pitch applied on this item. |
Variable Details¶
m_continueBetweenStates¶
bool m_continueBetweenStates
Whether to continue playing this item when the SwitchContainer * changes its state between one of the values where this item is registered.
If this value is set to false, each sound will be stopped and played again from the beginning.
m_fadeInAlgorithm¶
AmString m_fadeInAlgorithm
The name of the fading algorithm to use when this item starts playing.
m_fadeInDuration¶
AmTime m_fadeInDuration
The fade duration in milliseconds when this item starts playing.
m_fadeOutAlgorithm¶
AmString m_fadeOutAlgorithm
The name of the fading algorithm to use when this item stops playing.
m_fadeOutDuration¶
AmTime m_fadeOutDuration
The fade duration in milliseconds when this item stops playing.
m_gain¶
RtpcValue m_gain
The custom linear gain applied on this item.
The final gain will be computed with this value multiplied with the gain of the attenuation model, if any.
m_id¶
AmObjectID m_id
The object ID of the item.
May be a AmSoundID or a AmCollectionID.
m_pitch¶
RtpcValue m_pitch
The custom pitch applied on this item.
The final pitch will be computed with this value multiplied with the pitch of the doppler effect, if this switch container's spatialization mode is set to position.