Space Engineers
Classes | Public Member Functions | Properties | List of all members
Sandbox.Game.Components.MyCharacterSoundComponent Class Reference
Inheritance diagram for Sandbox.Game.Components.MyCharacterSoundComponent:
VRage.Game.Components.MyEntityComponentBase VRage.Game.Components.MyComponentBase

Public Member Functions

 MyCharacterSoundComponent ()
 
void Preload ()
 
void CharacterDied ()
 
void UpdateWindSounds ()
 
void UpdateBeforeSimulation100 ()
 
void PlayActionSound (MySoundPair actionSound)
 
void FindAndPlayStateSound ()
 
bool StopStateSound (bool forceStop=true)
 
void PlaySecondarySound (CharacterSoundsEnum soundEnum, bool stopPrevious=false)
 
void PlayDeathSound (MyStringHash damageType, bool stopPrevious=false)
 
void StartSecondarySound (string cueName, bool sync=false)
 
void StartSecondarySound (MyCueId cueId, bool sync=false)
 
bool StopSecondarySound (bool forceStop=true)
 
void PlayFallSound ()
 
void PlayDamageSound (float oldHealth)
 
override void OnAddedToContainer ()
 Gets called after the container of this component changes More...
 
override void OnBeforeRemovedFromContainer ()
 Gets called before the removal of this component from a container More...
 
- Public Member Functions inherited from VRage.Game.Components.MyEntityComponentBase
override void OnAddedToContainer ()
 Gets called after the container of this component changes More...
 
override void OnBeforeRemovedFromContainer ()
 Gets called before the removal of this component from a container More...
 
- Public Member Functions inherited from VRage.Game.Components.MyComponentBase
virtual void SetContainer (MyComponentContainer container)
 Sets the container of this component. Note that the component is not added to the container here! Therefore, use MyComponentContainer.Add(...) method and it will in turn call this method. Actually, you should seldom have the need to call this method yourself. More...
 
virtual T GetAs< T > ()
 
virtual void OnAddedToScene ()
 CH: TOOD: Be careful! This does not get called if the component is added to a container that is in the scene already! More...
 
virtual void OnRemovedFromScene ()
 CH: TOOD: Be careful! This does not get called if the component is removed from a container that is still in the scene! More...
 
virtual MyObjectBuilder_ComponentBase Serialize (bool copy=false)
 
virtual void Deserialize (MyObjectBuilder_ComponentBase builder)
 
virtual void Init (MyComponentDefinitionBase definition)
 
virtual bool IsSerialized ()
 Tells the component container serializer whether this component should be saved More...
 

Properties

MyCubeGrid StandingOnGrid [get]
 
MyVoxelBase StandingOnVoxel [get]
 
override string ComponentTypeDebugString [get]
 
- Properties inherited from VRage.Game.Components.MyEntityComponentBase
MyEntityComponentContainer Container [get]
 
IMyEntity Entity [get]
 
abstract string ComponentTypeDebugString [get]
 Name of the base component type for debug purposes (e.g.: "Position") More...
 
- Properties inherited from VRage.Game.Components.MyComponentBase
MyComponentContainer ContainerBase [get]
 This cannot be named Container to not conflict with the definition of Container in MyEntityComponentBase. More...
 

Additional Inherited Members

- Events inherited from VRage.Game.Components.MyEntityComponentBase
static Action< MyEntityComponentBaseOnAfterAddedToContainer
 
Action< MyEntityComponentBaseBeforeRemovedFromContainer
 

Detailed Description

Definition at line 62 of file MyCharacterSoundComponent.cs.

Constructor & Destructor Documentation

Sandbox.Game.Components.MyCharacterSoundComponent.MyCharacterSoundComponent ( )
inline

Definition at line 156 of file MyCharacterSoundComponent.cs.

Member Function Documentation

void Sandbox.Game.Components.MyCharacterSoundComponent.CharacterDied ( )
inline

Definition at line 225 of file MyCharacterSoundComponent.cs.

void Sandbox.Game.Components.MyCharacterSoundComponent.FindAndPlayStateSound ( )
inline

Definition at line 308 of file MyCharacterSoundComponent.cs.

override void Sandbox.Game.Components.MyCharacterSoundComponent.OnAddedToContainer ( )
inlinevirtual

Gets called after the container of this component changes

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 853 of file MyCharacterSoundComponent.cs.

override void Sandbox.Game.Components.MyCharacterSoundComponent.OnBeforeRemovedFromContainer ( )
inlinevirtual

Gets called before the removal of this component from a container

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 870 of file MyCharacterSoundComponent.cs.

void Sandbox.Game.Components.MyCharacterSoundComponent.PlayActionSound ( MySoundPair  actionSound)
inline

Definition at line 302 of file MyCharacterSoundComponent.cs.

void Sandbox.Game.Components.MyCharacterSoundComponent.PlayDamageSound ( float  oldHealth)
inline

Definition at line 838 of file MyCharacterSoundComponent.cs.

void Sandbox.Game.Components.MyCharacterSoundComponent.PlayDeathSound ( MyStringHash  damageType,
bool  stopPrevious = false 
)
inline

Definition at line 487 of file MyCharacterSoundComponent.cs.

void Sandbox.Game.Components.MyCharacterSoundComponent.PlayFallSound ( )
inline

Definition at line 744 of file MyCharacterSoundComponent.cs.

void Sandbox.Game.Components.MyCharacterSoundComponent.PlaySecondarySound ( CharacterSoundsEnum  soundEnum,
bool  stopPrevious = false 
)
inline

Definition at line 482 of file MyCharacterSoundComponent.cs.

void Sandbox.Game.Components.MyCharacterSoundComponent.Preload ( )
inline

Definition at line 217 of file MyCharacterSoundComponent.cs.

void Sandbox.Game.Components.MyCharacterSoundComponent.StartSecondarySound ( string  cueName,
bool  sync = false 
)
inline

Definition at line 495 of file MyCharacterSoundComponent.cs.

void Sandbox.Game.Components.MyCharacterSoundComponent.StartSecondarySound ( MyCueId  cueId,
bool  sync = false 
)
inline

Definition at line 500 of file MyCharacterSoundComponent.cs.

bool Sandbox.Game.Components.MyCharacterSoundComponent.StopSecondarySound ( bool  forceStop = true)
inline

Definition at line 512 of file MyCharacterSoundComponent.cs.

bool Sandbox.Game.Components.MyCharacterSoundComponent.StopStateSound ( bool  forceStop = true)
inline

Definition at line 476 of file MyCharacterSoundComponent.cs.

void Sandbox.Game.Components.MyCharacterSoundComponent.UpdateBeforeSimulation100 ( )
inline

Definition at line 289 of file MyCharacterSoundComponent.cs.

void Sandbox.Game.Components.MyCharacterSoundComponent.UpdateWindSounds ( )
inline

Definition at line 231 of file MyCharacterSoundComponent.cs.

Property Documentation

override string Sandbox.Game.Components.MyCharacterSoundComponent.ComponentTypeDebugString
get

Definition at line 879 of file MyCharacterSoundComponent.cs.

MyCubeGrid Sandbox.Game.Components.MyCharacterSoundComponent.StandingOnGrid
get

Definition at line 137 of file MyCharacterSoundComponent.cs.

MyVoxelBase Sandbox.Game.Components.MyCharacterSoundComponent.StandingOnVoxel
get

Definition at line 141 of file MyCharacterSoundComponent.cs.


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