mirror of
https://github.com/space-wizards/space-station-14.git
synced 2026-09-15 14:53:16 +02:00
604 lines
31 KiB
HTML
604 lines
31 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class InstrumentComponent
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class InstrumentComponent
|
|
">
|
|
<meta name="generator" content="docfx 2.56.7.0">
|
|
|
|
<link rel="shortcut icon" href="../../favicon.ico">
|
|
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../../styles/docfx.css">
|
|
<link rel="stylesheet" href="../../styles/main.css">
|
|
<meta property="docfx:navrel" content="../../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../../index.html">
|
|
<img id="logo" class="svg" src="../../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Content.Client.Instruments.InstrumentComponent">
|
|
|
|
|
|
<h1 id="Content_Client_Instruments_InstrumentComponent" data-uid="Content.Client.Instruments.InstrumentComponent" class="text-break">Class InstrumentComponent
|
|
</h1>
|
|
<div class="markdown level0 summary"></div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><a class="xref" href="../Content.Shared/Content.Shared.Instruments.SharedInstrumentComponent.html">SharedInstrumentComponent</a></div>
|
|
<div class="level2"><span class="xref">InstrumentComponent</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Content.Client.Instruments.html">Content.Client.Instruments</a></h6>
|
|
<h6><strong>Assembly</strong>: Content.Client.dll</h6>
|
|
<h5 id="Content_Client_Instruments_InstrumentComponent_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public sealed class InstrumentComponent : SharedInstrumentComponent</code></pre>
|
|
</div>
|
|
<h3 id="fields">Fields
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Instruments_InstrumentComponent_LastMeasured.md&value=---%0Auid%3A%20Content.Client.Instruments.InstrumentComponent.LastMeasured%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/space-wizards/space-station-14/blob/master/Content.Client/Instruments/InstrumentComponent.cs/#L22">View Source</a>
|
|
</span>
|
|
<h4 id="Content_Client_Instruments_InstrumentComponent_LastMeasured" data-uid="Content.Client.Instruments.InstrumentComponent.LastMeasured">LastMeasured</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public TimeSpan LastMeasured</code></pre>
|
|
</div>
|
|
<h5 class="fieldValue">Field Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">TimeSpan</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Instruments_InstrumentComponent_MidiEventBuffer.md&value=---%0Auid%3A%20Content.Client.Instruments.InstrumentComponent.MidiEventBuffer%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/space-wizards/space-station-14/blob/master/Content.Client/Instruments/InstrumentComponent.cs/#L31">View Source</a>
|
|
</span>
|
|
<h4 id="Content_Client_Instruments_InstrumentComponent_MidiEventBuffer" data-uid="Content.Client.Instruments.InstrumentComponent.MidiEventBuffer">MidiEventBuffer</h4>
|
|
<div class="markdown level1 summary"><p>A queue of MidiEvents to be sent to the server.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public readonly List<RobustMidiEvent> MidiEventBuffer</code></pre>
|
|
</div>
|
|
<h5 class="fieldValue">Field Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">List</span><<span class="xref">Robust.Shared.Audio.Midi.RobustMidiEvent</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Instruments_InstrumentComponent_Renderer.md&value=---%0Auid%3A%20Content.Client.Instruments.InstrumentComponent.Renderer%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/space-wizards/space-station-14/blob/master/Content.Client/Instruments/InstrumentComponent.cs/#L13">View Source</a>
|
|
</span>
|
|
<h4 id="Content_Client_Instruments_InstrumentComponent_Renderer" data-uid="Content.Client.Instruments.InstrumentComponent.Renderer">Renderer</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IMidiRenderer Renderer</code></pre>
|
|
</div>
|
|
<h5 class="fieldValue">Field Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">Robust.Client.Audio.Midi.IMidiRenderer</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Instruments_InstrumentComponent_SentWithinASec.md&value=---%0Auid%3A%20Content.Client.Instruments.InstrumentComponent.SentWithinASec%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/space-wizards/space-station-14/blob/master/Content.Client/Instruments/InstrumentComponent.cs/#L25">View Source</a>
|
|
</span>
|
|
<h4 id="Content_Client_Instruments_InstrumentComponent_SentWithinASec" data-uid="Content.Client.Instruments.InstrumentComponent.SentWithinASec">SentWithinASec</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public int SentWithinASec</code></pre>
|
|
</div>
|
|
<h5 class="fieldValue">Field Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Instruments_InstrumentComponent_SequenceDelay.md&value=---%0Auid%3A%20Content.Client.Instruments.InstrumentComponent.SequenceDelay%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/space-wizards/space-station-14/blob/master/Content.Client/Instruments/InstrumentComponent.cs/#L16">View Source</a>
|
|
</span>
|
|
<h4 id="Content_Client_Instruments_InstrumentComponent_SequenceDelay" data-uid="Content.Client.Instruments.InstrumentComponent.SequenceDelay">SequenceDelay</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public uint SequenceDelay</code></pre>
|
|
</div>
|
|
<h5 class="fieldValue">Field Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.UInt32</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Instruments_InstrumentComponent_SequenceStartTick.md&value=---%0Auid%3A%20Content.Client.Instruments.InstrumentComponent.SequenceStartTick%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/space-wizards/space-station-14/blob/master/Content.Client/Instruments/InstrumentComponent.cs/#L19">View Source</a>
|
|
</span>
|
|
<h4 id="Content_Client_Instruments_InstrumentComponent_SequenceStartTick" data-uid="Content.Client.Instruments.InstrumentComponent.SequenceStartTick">SequenceStartTick</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public uint SequenceStartTick</code></pre>
|
|
</div>
|
|
<h5 class="fieldValue">Field Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.UInt32</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Instruments_InstrumentComponent_Handheld.md&value=---%0Auid%3A%20Content.Client.Instruments.InstrumentComponent.Handheld%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/space-wizards/space-station-14/blob/master/Content.Client/Instruments/InstrumentComponent.cs/#L42">View Source</a>
|
|
</span>
|
|
<a id="Content_Client_Instruments_InstrumentComponent_Handheld_" data-uid="Content.Client.Instruments.InstrumentComponent.Handheld*"></a>
|
|
<h4 id="Content_Client_Instruments_InstrumentComponent_Handheld" data-uid="Content.Client.Instruments.InstrumentComponent.Handheld">Handheld</h4>
|
|
<div class="markdown level1 summary"><p>Whether this instrument is handheld or not.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool Handheld { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Instruments_InstrumentComponent_IsInputOpen.md&value=---%0Auid%3A%20Content.Client.Instruments.InstrumentComponent.IsInputOpen%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/space-wizards/space-station-14/blob/master/Content.Client/Instruments/InstrumentComponent.cs/#L54">View Source</a>
|
|
</span>
|
|
<a id="Content_Client_Instruments_InstrumentComponent_IsInputOpen_" data-uid="Content.Client.Instruments.InstrumentComponent.IsInputOpen*"></a>
|
|
<h4 id="Content_Client_Instruments_InstrumentComponent_IsInputOpen" data-uid="Content.Client.Instruments.InstrumentComponent.IsInputOpen">IsInputOpen</h4>
|
|
<div class="markdown level1 summary"><p>Whether the midi renderer is listening for midi input or not.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsInputOpen { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Instruments_InstrumentComponent_IsMidiOpen.md&value=---%0Auid%3A%20Content.Client.Instruments.InstrumentComponent.IsMidiOpen%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/space-wizards/space-station-14/blob/master/Content.Client/Instruments/InstrumentComponent.cs/#L48">View Source</a>
|
|
</span>
|
|
<a id="Content_Client_Instruments_InstrumentComponent_IsMidiOpen_" data-uid="Content.Client.Instruments.InstrumentComponent.IsMidiOpen*"></a>
|
|
<h4 id="Content_Client_Instruments_InstrumentComponent_IsMidiOpen" data-uid="Content.Client.Instruments.InstrumentComponent.IsMidiOpen">IsMidiOpen</h4>
|
|
<div class="markdown level1 summary"><p>Whether there's a midi song being played or not.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsMidiOpen { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Instruments_InstrumentComponent_IsRendererAlive.md&value=---%0Auid%3A%20Content.Client.Instruments.InstrumentComponent.IsRendererAlive%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/space-wizards/space-station-14/blob/master/Content.Client/Instruments/InstrumentComponent.cs/#L60">View Source</a>
|
|
</span>
|
|
<a id="Content_Client_Instruments_InstrumentComponent_IsRendererAlive_" data-uid="Content.Client.Instruments.InstrumentComponent.IsRendererAlive*"></a>
|
|
<h4 id="Content_Client_Instruments_InstrumentComponent_IsRendererAlive" data-uid="Content.Client.Instruments.InstrumentComponent.IsRendererAlive">IsRendererAlive</h4>
|
|
<div class="markdown level1 summary"><p>Whether the midi renderer is alive or not.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsRendererAlive { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Instruments_InstrumentComponent_LoopMidi.md&value=---%0Auid%3A%20Content.Client.Instruments.InstrumentComponent.LoopMidi%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/space-wizards/space-station-14/blob/master/Content.Client/Instruments/InstrumentComponent.cs/#L36">View Source</a>
|
|
</span>
|
|
<a id="Content_Client_Instruments_InstrumentComponent_LoopMidi_" data-uid="Content.Client.Instruments.InstrumentComponent.LoopMidi*"></a>
|
|
<h4 id="Content_Client_Instruments_InstrumentComponent_LoopMidi" data-uid="Content.Client.Instruments.InstrumentComponent.LoopMidi">LoopMidi</h4>
|
|
<div class="markdown level1 summary"><p>Whether a midi song will loop or not.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool LoopMidi { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Instruments_InstrumentComponent_PlayerTick.md&value=---%0Auid%3A%20Content.Client.Instruments.InstrumentComponent.PlayerTick%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/space-wizards/space-station-14/blob/master/Content.Client/Instruments/InstrumentComponent.cs/#L66">View Source</a>
|
|
</span>
|
|
<a id="Content_Client_Instruments_InstrumentComponent_PlayerTick_" data-uid="Content.Client.Instruments.InstrumentComponent.PlayerTick*"></a>
|
|
<h4 id="Content_Client_Instruments_InstrumentComponent_PlayerTick" data-uid="Content.Client.Instruments.InstrumentComponent.PlayerTick">PlayerTick</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public int PlayerTick { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Instruments_InstrumentComponent_PlayerTotalTick.md&value=---%0Auid%3A%20Content.Client.Instruments.InstrumentComponent.PlayerTotalTick%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/space-wizards/space-station-14/blob/master/Content.Client/Instruments/InstrumentComponent.cs/#L63">View Source</a>
|
|
</span>
|
|
<a id="Content_Client_Instruments_InstrumentComponent_PlayerTotalTick_" data-uid="Content.Client.Instruments.InstrumentComponent.PlayerTotalTick*"></a>
|
|
<h4 id="Content_Client_Instruments_InstrumentComponent_PlayerTotalTick" data-uid="Content.Client.Instruments.InstrumentComponent.PlayerTotalTick">PlayerTotalTick</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public int PlayerTotalTick { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Instruments_InstrumentComponent_PlaybackEndedInvoke.md&value=---%0Auid%3A%20Content.Client.Instruments.InstrumentComponent.PlaybackEndedInvoke%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/space-wizards/space-station-14/blob/master/Content.Client/Instruments/InstrumentComponent.cs/#L69">View Source</a>
|
|
</span>
|
|
<a id="Content_Client_Instruments_InstrumentComponent_PlaybackEndedInvoke_" data-uid="Content.Client.Instruments.InstrumentComponent.PlaybackEndedInvoke*"></a>
|
|
<h4 id="Content_Client_Instruments_InstrumentComponent_PlaybackEndedInvoke" data-uid="Content.Client.Instruments.InstrumentComponent.PlaybackEndedInvoke">PlaybackEndedInvoke()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void PlaybackEndedInvoke()</code></pre>
|
|
</div>
|
|
<h3 id="events">Events
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Instruments_InstrumentComponent_OnMidiPlaybackEnded.md&value=---%0Auid%3A%20Content.Client.Instruments.InstrumentComponent.OnMidiPlaybackEnded%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/space-wizards/space-station-14/blob/master/Content.Client/Instruments/InstrumentComponent.cs/#L10">View Source</a>
|
|
</span>
|
|
<h4 id="Content_Client_Instruments_InstrumentComponent_OnMidiPlaybackEnded" data-uid="Content.Client.Instruments.InstrumentComponent.OnMidiPlaybackEnded">OnMidiPlaybackEnded</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event Action? OnMidiPlaybackEnded</code></pre>
|
|
</div>
|
|
<h5 class="eventType">Event Type</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">Action</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
<li>
|
|
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Instruments_InstrumentComponent.md&value=---%0Auid%3A%20Content.Client.Instruments.InstrumentComponent%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
|
|
</li>
|
|
<li>
|
|
<a href="https://github.com/space-wizards/space-station-14/blob/master/Content.Client/Instruments/InstrumentComponent.cs/#L7" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="toggle-mode">
|
|
<div class="icon">
|
|
<i aria-hidden="true">☀</i>
|
|
</div>
|
|
<label class="switch">
|
|
<input type="checkbox" id="switch-style">
|
|
<span class="slider round"></span>
|
|
</label>
|
|
<div class="icon">
|
|
<i aria-hidden="true">☾</i>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<h5>In This Article</h5>
|
|
<div></div>
|
|
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
<div class="pull-left">
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
<div class="toggle-mode pull-right visible-sm visible-xs">
|
|
<div class="icon">
|
|
<i aria-hidden="true">☀</i>
|
|
</div>
|
|
<label class="switch">
|
|
<input type="checkbox" id="switch-style-m">
|
|
<span class="slider round"></span>
|
|
</label>
|
|
<div class="icon">
|
|
<i aria-hidden="true">☾</i>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript" src="../../styles/toggle-theme.js"></script>
|
|
</footer> </div>
|
|
|
|
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../../styles/main.js"></script>
|
|
</body>
|
|
</html>
|