Show / Hide Table of Contents

Class MyCharacterSoundComponent

Inheritance
System.Object
MyComponentBase
MyEntityComponentBase
MyEventProxyEntityComponent
MyUpdatingEntityComponent
MyCharacterSoundComponent
Implements
IMyCharacterComponent
Inherited Members
MyUpdatingEntityComponent.UpdateOnceBeforeFrame()
MyUpdatingEntityComponent.UpdateBeforeSimulation()
MyUpdatingEntityComponent.UpdateBeforeSimulation100()
MyUpdatingEntityComponent.UpdateBeforeSimulationParallel()
MyUpdatingEntityComponent.UpdateSimulate()
MyUpdatingEntityComponent.UpdateAfterSimulation10()
MyUpdatingEntityComponent.ParentEntity
MyUpdatingEntityComponent.NeedsUpdate
MyUpdatingEntityComponent.NeedsUpdateBeforeSimulation
MyUpdatingEntityComponent.NeedsUpdateBeforeSimulation100
MyUpdatingEntityComponent.NeedsUpdateSimulation
MyUpdatingEntityComponent.NeedsUpdateAfterSimulation
MyUpdatingEntityComponent.NeedsUpdateAfterSimulation10
MyUpdatingEntityComponent.NeedsUpdateAfterSimulation100
MyUpdatingEntityComponent.UpdateParallel
MyUpdatingEntityComponent.UpdatingType
MyUpdatingEntityComponent.NeedsUpdateChanged
MyUpdatingEntityComponent.UpdateParallelChanged
MyEventProxyEntityComponent.SyncType
MyEventProxyEntityComponent.AttachSyncToEntity
MyEntityComponentBase.Container
MyEntityComponentBase.Entity
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 : MyUpdatingEntityComponent, IMyEntityComponentBase, IMyComponentBase, IMyEventProxy, IMyEventOwner, IMyUpdatingEntityComponent, IMyCharacterComponent

Constructors

MyCharacterSoundComponent()

Declaration
public MyCharacterSoundComponent()

Properties

Character

Declaration
public MyCharacter Character { get; }
Property Value
Type Description
Sandbox.Game.Entities.Character.MyCharacter

ComponentTypeDebugString

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

StandingOnGrid

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

StandingOnVoxel

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

Methods

OnAddedToContainer()

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

OnBeforeRemovedFromContainer()

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

OnCharacterDead()

Declaration
public void OnCharacterDead()

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
MyUpdatingEntityComponent.UpdateAfterSimulation()

UpdateAfterSimulation100()

Declaration
public override void UpdateAfterSimulation100()
Overrides
MyUpdatingEntityComponent.UpdateAfterSimulation100()

UpdateAfterSimulationParallel()

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

Implements

IMyCharacterComponent

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
☀
☾