Show / Hide Table of Contents

Class InstrumentSystem

Inheritance
System.Object
SharedInstrumentSystem
InstrumentSystem
Namespace: Content.Client.Instruments
Assembly: Content.Client.dll
Syntax
public sealed class InstrumentSystem : SharedInstrumentSystem

Fields

| Improve this Doc View Source

OneSecAgo

Declaration
public readonly TimeSpan OneSecAgo
Field Value
Type Description
TimeSpan

Properties

| Improve this Doc View Source

MaxMidiEventsPerBatch

Declaration
public int MaxMidiEventsPerBatch { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

MaxMidiEventsPerSecond

Declaration
public int MaxMidiEventsPerSecond { get; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

CloseInput(EntityUid, Boolean, InstrumentComponent)

Declaration
public bool CloseInput(EntityUid uid, bool fromStateChange, InstrumentComponent instrument = null)
Parameters
Type Name Description
EntityUid uid
System.Boolean fromStateChange
InstrumentComponent instrument
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CloseMidi(EntityUid, Boolean, InstrumentComponent)

Declaration
public bool CloseMidi(EntityUid uid, bool fromStateChange, InstrumentComponent instrument = null)
Parameters
Type Name Description
EntityUid uid
System.Boolean fromStateChange
InstrumentComponent instrument
Returns
Type Description
System.Boolean
| Improve this Doc View Source

EndRenderer(EntityUid, Boolean, SharedInstrumentComponent)

Declaration
public override void EndRenderer(EntityUid uid, bool fromStateChange, SharedInstrumentComponent component = null)
Parameters
Type Name Description
EntityUid uid
System.Boolean fromStateChange
SharedInstrumentComponent component
| Improve this Doc View Source

Initialize()

Declaration
public override void Initialize()
| Improve this Doc View Source

OpenInput(EntityUid, InstrumentComponent)

Declaration
public bool OpenInput(EntityUid uid, InstrumentComponent instrument = null)
Parameters
Type Name Description
EntityUid uid
InstrumentComponent instrument
Returns
Type Description
System.Boolean
| Improve this Doc View Source

OpenMidi(EntityUid, ReadOnlySpan<Byte>, InstrumentComponent)

Declaration
public bool OpenMidi(EntityUid uid, ReadOnlySpan<byte> data, InstrumentComponent instrument = null)
Parameters
Type Name Description
EntityUid uid
ReadOnlySpan<System.Byte> data
InstrumentComponent instrument
Returns
Type Description
System.Boolean
| Improve this Doc View Source

ResolveInstrument(EntityUid, ref SharedInstrumentComponent)

Declaration
public override bool ResolveInstrument(EntityUid uid, ref SharedInstrumentComponent component)
Parameters
Type Name Description
EntityUid uid
SharedInstrumentComponent component
Returns
Type Description
System.Boolean
| Improve this Doc View Source

SetFilteredChannel(EntityUid, Int32, Boolean)

Declaration
public void SetFilteredChannel(EntityUid uid, int channel, bool value)
Parameters
Type Name Description
EntityUid uid
System.Int32 channel
System.Boolean value
| Improve this Doc View Source

SetMaster(EntityUid, Nullable<EntityUid>)

Declaration
public void SetMaster(EntityUid uid, EntityUid? masterUid)
Parameters
Type Name Description
EntityUid uid
System.Nullable<EntityUid> masterUid
| Improve this Doc View Source

SetPlayerTick(EntityUid, Int32, InstrumentComponent)

Declaration
public void SetPlayerTick(EntityUid uid, int playerTick, InstrumentComponent instrument = null)
Parameters
Type Name Description
EntityUid uid
System.Int32 playerTick
InstrumentComponent instrument
| Improve this Doc View Source

SetupRenderer(EntityUid, Boolean, SharedInstrumentComponent)

Declaration
public override void SetupRenderer(EntityUid uid, bool fromStateChange, SharedInstrumentComponent component = null)
Parameters
Type Name Description
EntityUid uid
System.Boolean fromStateChange
SharedInstrumentComponent component
| Improve this Doc View Source

Shutdown()

Declaration
public override void Shutdown()
| Improve this Doc View Source

Update(Single)

Declaration
public override void Update(float frameTime)
Parameters
Type Name Description
System.Single frameTime
| Improve this Doc View Source

UpdateRenderer(EntityUid, InstrumentComponent)

Declaration
public void UpdateRenderer(EntityUid uid, InstrumentComponent instrument = null)
Parameters
Type Name Description
EntityUid uid
InstrumentComponent instrument
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾