stmm-games-doc  0.32.0
Public Attributes | List of all members
stmg::SoundEvent::LocalInit Struct Reference
Inheritance diagram for stmg::SoundEvent::LocalInit:
Inheritance graph
[legend]

Public Attributes

int32_t m_nSoundTeam = -1
 The preferences team (not the level team) the sound is played for or -1 if all players. More...
 
int32_t m_nSoundMate = -1
 The mate nr of the player the sound is played for or -1 if a team or whole game sound. More...
 
int32_t m_nSoundIdx = -1
 The sound id. More...
 
FPoint m_oPosXY
 The initial x and y position of the sound in tiles within the board. More...
 
double m_fPosZ = 0
 The initial z position of the sound in tiles. More...
 
bool m_bListenerRelative = true
 Whether the sound is listener relative. More...
 
bool m_bLooping = false
 Whether the sound is looping. More...
 
double m_fVolume = 1.0
 The volume. More...
 

Member Data Documentation

◆ m_bListenerRelative

bool stmg::SoundEvent::LocalInit::m_bListenerRelative = true

Whether the sound is listener relative.

Default is true.

◆ m_bLooping

bool stmg::SoundEvent::LocalInit::m_bLooping = false

Whether the sound is looping.

Default is false.

◆ m_fPosZ

double stmg::SoundEvent::LocalInit::m_fPosZ = 0

The initial z position of the sound in tiles.

Default is 0.

◆ m_fVolume

double stmg::SoundEvent::LocalInit::m_fVolume = 1.0

The volume.

Must be a value between 0 (inaudible) and 1 (max). Default is 1.

◆ m_nSoundIdx

int32_t stmg::SoundEvent::LocalInit::m_nSoundIdx = -1

The sound id.

An index into Named::sounds(). Must be valid or -1 if not defined. Default is -1.

◆ m_nSoundMate

int32_t stmg::SoundEvent::LocalInit::m_nSoundMate = -1

The mate nr of the player the sound is played for or -1 if a team or whole game sound.

Default is -1.

◆ m_nSoundTeam

int32_t stmg::SoundEvent::LocalInit::m_nSoundTeam = -1

The preferences team (not the level team) the sound is played for or -1 if all players.

Default is -1.

◆ m_oPosXY

FPoint stmg::SoundEvent::LocalInit::m_oPosXY

The initial x and y position of the sound in tiles within the board.