Inheritance diagram for Sandbox.Game.Entities.MyEntity3DSoundEmitter:

Public Types
enum	MethodsEnum { MethodsEnum.CanHear, MethodsEnum.ShouldPlay2D, MethodsEnum.CueType, MethodsEnum.ImplicitEffect }

Public Member Functions
void	SetPosition (Vector3?position)

void	SetVelocity (Vector3?velocity)

	MyEntity3DSoundEmitter (MyEntity entity, bool useStaticList=false)

void	Update ()

bool	FastUpdate (bool silenced)

void	PlaySound (byte[] buffer, int size, int sampleRate, float volume=1, float maxDistance=0, MySoundDimensions dimension=MySoundDimensions.D3)

void	PlaySingleSound (MyCueId soundId, bool stopPrevious=false, bool skipIntro=false)

void	PlaySingleSound (MySoundPair soundId, bool stopPrevious=false, bool skipIntro=false, bool skipToEnd=false)

void	PlaySound (MySoundPair soundId, bool stopPrevious=false, bool skipIntro=false, bool force2D=false, bool alwaysHearOnRealistic=false, bool skipToEnd=false)

void	PlaySoundWithDistance (MyCueId soundId, bool stopPrevious=false, bool skipIntro=false, bool force2D=false, bool useDistanceCheck=true, bool alwaysHearOnRealistic=false, bool skipToEnd=false)

void	StopSound (bool forced, bool cleanUp=true)

void	Cleanup ()

Static Public Member Functions
static void	PreloadSound (MySoundPair soundId)

static void	UpdateEntityEmitters (bool removeUnused, bool updatePlaying, bool updateNotPlaying)

static void	ClearEntityEmitters ()

Public Attributes
Dictionary< MethodsEnum, List< Delegate > >	EmitterMethods = new Dictionary<MethodsEnum, List<Delegate>>()

bool	CanPlayLoopSounds = true

Properties
bool	Loop `[get]`

bool	IsPlaying `[get]`

MyCueId	SoundId `[get, set]`

MySoundData	LastSoundData `[get]`

float	VolumeMultiplier `[get, set]`

MySoundPair	SoundPair `[get]`

IMySourceVoice	Sound `[get, set]`

Vector3	SourcePosition `[get]`

Vector3	Velocity `[get]`

MyEntity	Entity `[get, set]`

float	CustomMaxDistance `[get, set]`

float	CustomVolume `[get, set]`

bool	Force3D `[get, set]`

bool	Force2D `[get, set]`

bool	Plays2D `[get]`

int	SourceChannels `[get, set]`

Properties inherited from VRage.Audio.IMy3DSoundEmitter
MyCueId	SoundId `[get]`

IMySourceVoice	Sound `[get, set]`

Vector3	SourcePosition `[get]`

Vector3	Velocity `[get]`

float	CustomMaxDistance `[get]`

float	CustomVolume `[get]`

bool	Realistic `[get]`

bool	Force3D `[get]`

bool	Plays2D `[get]`

int	SourceChannels `[get, set]`

int	LastPlayedWaveNumber `[get, set]`

Events
Action< MyEntity3DSoundEmitter >	StoppedPlaying

Detailed Description

Definition at line 169 of file MyEntity3DSoundEmitter.cs.

Member Enumeration Documentation

enum Sandbox.Game.Entities.MyEntity3DSoundEmitter.MethodsEnum

Enumerator
CanHear
ShouldPlay2D
CueType
ImplicitEffect

Definition at line 173 of file MyEntity3DSoundEmitter.cs.

Constructor & Destructor Documentation

Sandbox.Game.Entities.MyEntity3DSoundEmitter.MyEntity3DSoundEmitter	(	MyEntity	entity,
		bool	useStaticList = `false`
	)

inline

Definition at line 287 of file MyEntity3DSoundEmitter.cs.

Member Function Documentation

void Sandbox.Game.Entities.MyEntity3DSoundEmitter.Cleanup ( )

inline

Definition at line 930 of file MyEntity3DSoundEmitter.cs.

static void Sandbox.Game.Entities.MyEntity3DSoundEmitter.ClearEntityEmitters ( )

inlinestatic

Definition at line 991 of file MyEntity3DSoundEmitter.cs.

bool Sandbox.Game.Entities.MyEntity3DSoundEmitter.FastUpdate ( bool silenced )

inline

Definition at line 387 of file MyEntity3DSoundEmitter.cs.

void Sandbox.Game.Entities.MyEntity3DSoundEmitter.PlaySingleSound	(	MyCueId	soundId,
		bool	stopPrevious = `false`,
		bool	skipIntro = `false`
	)

inline

Definition at line 694 of file MyEntity3DSoundEmitter.cs.

void Sandbox.Game.Entities.MyEntity3DSoundEmitter.PlaySingleSound	(	MySoundPair	soundId,
		bool	stopPrevious = `false`,
		bool	skipIntro = `false`,
		bool	skipToEnd = `false`
	)

inline

Definition at line 702 of file MyEntity3DSoundEmitter.cs.

void Sandbox.Game.Entities.MyEntity3DSoundEmitter.PlaySound	(	byte[]	buffer,
		int	size,
		int	sampleRate,
		float	volume = `1`,
		float	maxDistance = `0`,
		MySoundDimensions	dimension = `MySoundDimensions.D3`
	)

inline

Definition at line 680 of file MyEntity3DSoundEmitter.cs.

void Sandbox.Game.Entities.MyEntity3DSoundEmitter.PlaySound	(	MySoundPair	soundId,
		bool	stopPrevious = `false`,
		bool	skipIntro = `false`,
		bool	force2D = `false`,
		bool	alwaysHearOnRealistic = `false`,
		bool	skipToEnd = `false`
	)

inline

Definition at line 718 of file MyEntity3DSoundEmitter.cs.

void Sandbox.Game.Entities.MyEntity3DSoundEmitter.PlaySoundWithDistance	(	MyCueId	soundId,
		bool	stopPrevious = `false`,
		bool	skipIntro = `false`,
		bool	force2D = `false`,
		bool	useDistanceCheck = `true`,
		bool	alwaysHearOnRealistic = `false`,
		bool	skipToEnd = `false`
	)

inline

Definition at line 735 of file MyEntity3DSoundEmitter.cs.

static void Sandbox.Game.Entities.MyEntity3DSoundEmitter.PreloadSound ( MySoundPair soundId )

inlinestatic

Definition at line 954 of file MyEntity3DSoundEmitter.cs.

void Sandbox.Game.Entities.MyEntity3DSoundEmitter.SetPosition ( Vector3? position )

inline

Definition at line 274 of file MyEntity3DSoundEmitter.cs.

void Sandbox.Game.Entities.MyEntity3DSoundEmitter.SetVelocity ( Vector3? velocity )

inline

Definition at line 279 of file MyEntity3DSoundEmitter.cs.

void Sandbox.Game.Entities.MyEntity3DSoundEmitter.StopSound	(	bool	forced,
		bool	cleanUp = `true`
	)

inline

Definition at line 889 of file MyEntity3DSoundEmitter.cs.

void Sandbox.Game.Entities.MyEntity3DSoundEmitter.Update ( )

inline

Definition at line 336 of file MyEntity3DSoundEmitter.cs.

static void Sandbox.Game.Entities.MyEntity3DSoundEmitter.UpdateEntityEmitters	(	bool	removeUnused,
		bool	updatePlaying,
		bool	updateNotPlaying
	)

inlinestatic

Definition at line 965 of file MyEntity3DSoundEmitter.cs.

Member Data Documentation

bool Sandbox.Game.Entities.MyEntity3DSoundEmitter.CanPlayLoopSounds = true

Definition at line 219 of file MyEntity3DSoundEmitter.cs.

Dictionary<MethodsEnum, List<Delegate> > Sandbox.Game.Entities.MyEntity3DSoundEmitter.EmitterMethods = new Dictionary<MethodsEnum, List<Delegate>>()

Definition at line 213 of file MyEntity3DSoundEmitter.cs.

Property Documentation

float Sandbox.Game.Entities.MyEntity3DSoundEmitter.CustomMaxDistance

getset

Definition at line 1033 of file MyEntity3DSoundEmitter.cs.

float Sandbox.Game.Entities.MyEntity3DSoundEmitter.CustomVolume

getset

Definition at line 1040 of file MyEntity3DSoundEmitter.cs.

MyEntity Sandbox.Game.Entities.MyEntity3DSoundEmitter.Entity

getset

Definition at line 1022 of file MyEntity3DSoundEmitter.cs.

bool Sandbox.Game.Entities.MyEntity3DSoundEmitter.Force2D

getset

Definition at line 1059 of file MyEntity3DSoundEmitter.cs.

bool Sandbox.Game.Entities.MyEntity3DSoundEmitter.Force3D

getset

Definition at line 1053 of file MyEntity3DSoundEmitter.cs.

bool Sandbox.Game.Entities.MyEntity3DSoundEmitter.IsPlaying

get

Definition at line 221 of file MyEntity3DSoundEmitter.cs.

MySoundData Sandbox.Game.Entities.MyEntity3DSoundEmitter.LastSoundData

get

Definition at line 237 of file MyEntity3DSoundEmitter.cs.

bool Sandbox.Game.Entities.MyEntity3DSoundEmitter.Loop

get

Definition at line 217 of file MyEntity3DSoundEmitter.cs.

bool Sandbox.Game.Entities.MyEntity3DSoundEmitter.Plays2D

get

Definition at line 1065 of file MyEntity3DSoundEmitter.cs.

IMySourceVoice Sandbox.Game.Entities.MyEntity3DSoundEmitter.Sound

getset

Definition at line 269 of file MyEntity3DSoundEmitter.cs.

MyCueId Sandbox.Game.Entities.MyEntity3DSoundEmitter.SoundId

getset

Definition at line 224 of file MyEntity3DSoundEmitter.cs.

MySoundPair Sandbox.Game.Entities.MyEntity3DSoundEmitter.SoundPair

get

Definition at line 261 of file MyEntity3DSoundEmitter.cs.

int Sandbox.Game.Entities.MyEntity3DSoundEmitter.SourceChannels

getset

Definition at line 1070 of file MyEntity3DSoundEmitter.cs.

Vector3 Sandbox.Game.Entities.MyEntity3DSoundEmitter.SourcePosition

get

Definition at line 1001 of file MyEntity3DSoundEmitter.cs.

Vector3 Sandbox.Game.Entities.MyEntity3DSoundEmitter.Velocity

get

Definition at line 1013 of file MyEntity3DSoundEmitter.cs.

float Sandbox.Game.Entities.MyEntity3DSoundEmitter.VolumeMultiplier

getset

Definition at line 250 of file MyEntity3DSoundEmitter.cs.

Event Documentation

Action<MyEntity3DSoundEmitter> Sandbox.Game.Entities.MyEntity3DSoundEmitter.StoppedPlaying

Definition at line 215 of file MyEntity3DSoundEmitter.cs.

The documentation for this class was generated from the following file:

Sources/Sandbox.Game/Game/Audio/MyEntity3DSoundEmitter.cs

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Properties

Events

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation

Event Documentation