Show / Hide Table of Contents

Class MyCharacterSoundComponent

Inheritance
System.Object
MyComponentBase
MyEntityComponentBase
MyCharacterComponent
MyCharacterSoundComponent
Inherited Members
MyCharacterComponent.UpdateAfterSimulation10()
MyCharacterComponent.UpdateBeforeSimulation()
MyCharacterComponent.UpdateBeforeSimulationParallel()
MyCharacterComponent.Simulate()
MyCharacterComponent.UpdateBeforeSimulation100()
MyCharacterComponent.OnCharacterDead()
MyCharacterComponent.NeedsUpdateAfterSimulation
MyCharacterComponent.NeedsUpdateAfterSimulationParallel
MyCharacterComponent.NeedsUpdateSimulation
MyCharacterComponent.NeedsUpdateAfterSimulation10
MyCharacterComponent.NeedsUpdateBeforeSimulation100
MyCharacterComponent.NeedsUpdateBeforeSimulation
MyCharacterComponent.NeedsUpdateBeforeSimulationParallel
MyCharacterComponent.Character
MyEntityComponentBase.Container
MyEntityComponentBase.Entity
MyEntityComponentBase.AttachSyncToEntity
MyEntityComponentBase.OnAfterAddedToContainer
MyEntityComponentBase.BeforeRemovedFromContainer
MyComponentBase.SetContainer(IMyComponentContainer)
MyComponentBase.GetAs<T>()
MyComponentBase.OnAddedToScene()
MyComponentBase.OnRemovedFromScene()
MyComponentBase.Serialize(Boolean)
MyComponentBase.Deserialize(MyObjectBuilder_ComponentBase)
MyComponentBase.Init(MyComponentDefinitionBase)
MyComponentBase.IsSerialized()
MyComponentBase.RemoveExistingComponentOnNewInsert
MyComponentBase.ContainerBase
Namespace: Sandbox.Game.Components
Assembly: Sandbox.Game.dll
Syntax
[MyComponentBuilder]
public class MyCharacterSoundComponent : MyCharacterComponent, IMyEntityComponentBase, IMyComponentBase

Constructors

MyCharacterSoundComponent()

Declaration
public MyCharacterSoundComponent()

Properties

ComponentTypeDebugString

Declaration
public override string ComponentTypeDebugString { get; }
Property Value
Type Description
System.String
Overrides
MyCharacterComponent.ComponentTypeDebugString

StandingOnGrid

Declaration
public MyCubeGrid StandingOnGrid { get; }
Property Value
Type Description
MyCubeGrid

StandingOnVoxel

Declaration
public MyVoxelBase StandingOnVoxel { get; }
Property Value
Type Description
MyVoxelBase

Methods

CharacterDied()

Declaration
public void CharacterDied()

OnAddedToContainer()

Declaration
public override void OnAddedToContainer()
Overrides
MyCharacterComponent.OnAddedToContainer()

OnBeforeRemovedFromContainer()

Declaration
public override void OnBeforeRemovedFromContainer()
Overrides
MyCharacterComponent.OnBeforeRemovedFromContainer()

PlayActionSound(MySoundPair, Nullable<Boolean>)

Declaration
public void PlayActionSound(MySoundPair actionSound, Nullable<bool> force3D = null)
Parameters
Type Name Description
MySoundPair actionSound
System.Nullable<System.Boolean> force3D

PlayDamageSound(Single)

Declaration
public void PlayDamageSound(float oldHealth)
Parameters
Type Name Description
System.Single oldHealth

PlayDeathSound(MyStringHash, Boolean)

Declaration
public void PlayDeathSound(MyStringHash damageType, bool stopPrevious = false)
Parameters
Type Name Description
MyStringHash damageType
System.Boolean stopPrevious

PlayFallSound()

Declaration
public void PlayFallSound()

PlaySecondarySound(CharacterSoundsEnum, Boolean, Boolean, Nullable<Boolean>)

Declaration
public void PlaySecondarySound(CharacterSoundsEnum soundEnum, bool stopPrevious = false, bool force2D = false, Nullable<bool> force3D = null)
Parameters
Type Name Description
CharacterSoundsEnum soundEnum
System.Boolean stopPrevious
System.Boolean force2D
System.Nullable<System.Boolean> force3D

Preload()

Declaration
public void Preload()

StartSecondarySound(String, Boolean)

Declaration
public void StartSecondarySound(string cueName, bool sync = false)
Parameters
Type Name Description
System.String cueName
System.Boolean sync

StartSecondarySound(MyCueId, Boolean)

Declaration
public void StartSecondarySound(MyCueId cueId, bool sync = false)
Parameters
Type Name Description
VRage.Audio.MyCueId cueId
System.Boolean sync

StopSecondarySound(Boolean)

Declaration
public bool StopSecondarySound(bool forceStop = true)
Parameters
Type Name Description
System.Boolean forceStop
Returns
Type Description
System.Boolean

StopStateSound(Boolean)

Declaration
public bool StopStateSound(bool forceStop = true)
Parameters
Type Name Description
System.Boolean forceStop
Returns
Type Description
System.Boolean

UpdateAfterSimulation()

Declaration
public override void UpdateAfterSimulation()
Overrides
MyCharacterComponent.UpdateAfterSimulation()

UpdateAfterSimulation100()

Declaration
public void UpdateAfterSimulation100()

UpdateAfterSimulationParallel()

Declaration
public override void UpdateAfterSimulationParallel()
Overrides
MyCharacterComponent.UpdateAfterSimulationParallel()

UpdateWindSounds()

Declaration
public void UpdateWindSounds()

Extension Methods

MyEntityContainerEventExtensions.RegisterForEntityEvent(MyEntityComponentBase, MyStringHash, MyEntityContainerEventExtensions.EntityEventHandler)
MyEntityContainerEventExtensions.RegisterForEntityEvent(MyEntityComponentBase, MyEntity, MyStringHash, MyEntityContainerEventExtensions.EntityEventHandler)
MyEntityContainerEventExtensions.UnregisterForEntityEvent(MyEntityComponentBase, MyEntity, MyStringHash)
MyEntityContainerEventExtensions.RaiseEntityEvent(MyEntityComponentBase, MyStringHash, MyEntityContainerEventExtensions.EntityEventParams)
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾