mirror of
https://github.com/space-wizards/RobustToolbox.git
synced 2026-02-14 19:29:36 +01:00
931 lines
51 KiB
HTML
931 lines
51 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 AudioSystem
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class AudioSystem
|
|
">
|
|
<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="Robust.Client.GameObjects.AudioSystem">
|
|
|
|
|
|
<h1 id="Robust_Client_GameObjects_AudioSystem" data-uid="Robust.Client.GameObjects.AudioSystem" class="text-break">Class AudioSystem
|
|
</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="../Robust.Shared/Robust.Shared.GameObjects.EntitySystem.html">EntitySystem</a></div>
|
|
<div class="level2"><a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.SharedAudioSystem.html">SharedAudioSystem</a></div>
|
|
<div class="level3"><span class="xref">AudioSystem</span></div>
|
|
</div>
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.IEntitySystem.html">IEntitySystem</a></div>
|
|
<div><a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.IEntityEventSubscriber.html">IEntityEventSubscriber</a></div>
|
|
<div><a class="xref" href="../Robust.Shared/Robust.Shared.IoC.IPostInjectInit.html">IPostInjectInit</a></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Robust.Client.GameObjects.html">Robust.Client.GameObjects</a></h6>
|
|
<h6><strong>Assembly</strong>: Robust.Client.dll</h6>
|
|
<h5 id="Robust_Client_GameObjects_AudioSystem_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public sealed class AudioSystem : SharedAudioSystem, IEntitySystem, IEntityEventSubscriber, IPostInjectInit</code></pre>
|
|
</div>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_AudioSystem_FrameUpdate_System_Single_.md&value=---%0Auid%3A%20Robust.Client.GameObjects.AudioSystem.FrameUpdate(System.Single)%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/RobustToolbox/blob/master/Robust.Client/GameObjects/EntitySystems/AudioSystem.cs/#L125">View Source</a>
|
|
</span>
|
|
<a id="Robust_Client_GameObjects_AudioSystem_FrameUpdate_" data-uid="Robust.Client.GameObjects.AudioSystem.FrameUpdate*"></a>
|
|
<h4 id="Robust_Client_GameObjects_AudioSystem_FrameUpdate_System_Single_" data-uid="Robust.Client.GameObjects.AudioSystem.FrameUpdate(System.Single)">FrameUpdate(Single)</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 override void FrameUpdate(float frameTime)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><span class="parametername">frameTime</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.EntitySystem.html#Robust_Shared_GameObjects_EntitySystem_FrameUpdate_System_Single_">EntitySystem.FrameUpdate(Single)</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_AudioSystem_Initialize.md&value=---%0Auid%3A%20Robust.Client.GameObjects.AudioSystem.Initialize%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/RobustToolbox/blob/master/Robust.Client/GameObjects/EntitySystems/AudioSystem.cs/#L51">View Source</a>
|
|
</span>
|
|
<a id="Robust_Client_GameObjects_AudioSystem_Initialize_" data-uid="Robust.Client.GameObjects.AudioSystem.Initialize*"></a>
|
|
<h4 id="Robust_Client_GameObjects_AudioSystem_Initialize" data-uid="Robust.Client.GameObjects.AudioSystem.Initialize">Initialize()</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 override void Initialize()</code></pre>
|
|
</div>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.EntitySystem.html#Robust_Shared_GameObjects_EntitySystem_Initialize">EntitySystem.Initialize()</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_AudioSystem_Play_System_String_Robust_Shared_Player_Filter_Robust_Shared_GameObjects_EntityUid_System_Boolean_System_Nullable_Robust_Shared_Audio_AudioParams__.md&value=---%0Auid%3A%20Robust.Client.GameObjects.AudioSystem.Play(System.String%2CRobust.Shared.Player.Filter%2CRobust.Shared.GameObjects.EntityUid%2CSystem.Boolean%2CSystem.Nullable%7BRobust.Shared.Audio.AudioParams%7D)%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/RobustToolbox/blob/master/Robust.Client/GameObjects/EntitySystems/AudioSystem.cs/#L581">View Source</a>
|
|
</span>
|
|
<a id="Robust_Client_GameObjects_AudioSystem_Play_" data-uid="Robust.Client.GameObjects.AudioSystem.Play*"></a>
|
|
<h4 id="Robust_Client_GameObjects_AudioSystem_Play_System_String_Robust_Shared_Player_Filter_Robust_Shared_GameObjects_EntityUid_System_Boolean_System_Nullable_Robust_Shared_Audio_AudioParams__" data-uid="Robust.Client.GameObjects.AudioSystem.Play(System.String,Robust.Shared.Player.Filter,Robust.Shared.GameObjects.EntityUid,System.Boolean,System.Nullable{Robust.Shared.Audio.AudioParams})">Play(String, Filter, EntityUid, Boolean, Nullable<AudioParams>)</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 override IPlayingAudioStream Play(string filename, Filter playerFilter, EntityUid entity, bool recordReplay, AudioParams? audioParams = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">filename</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Player.Filter.html">Filter</a></td>
|
|
<td><span class="parametername">playerFilter</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.EntityUid.html">EntityUid</a></td>
|
|
<td><span class="parametername">entity</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">recordReplay</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<a class="xref" href="../Robust.Shared/Robust.Shared.Audio.AudioParams.html">AudioParams</a>></td>
|
|
<td><span class="parametername">audioParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Audio.IPlayingAudioStream.html">IPlayingAudioStream</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_AudioSystem_Play_System_String_Robust_Shared_Player_Filter_Robust_Shared_Map_EntityCoordinates_System_Boolean_System_Nullable_Robust_Shared_Audio_AudioParams__.md&value=---%0Auid%3A%20Robust.Client.GameObjects.AudioSystem.Play(System.String%2CRobust.Shared.Player.Filter%2CRobust.Shared.Map.EntityCoordinates%2CSystem.Boolean%2CSystem.Nullable%7BRobust.Shared.Audio.AudioParams%7D)%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/RobustToolbox/blob/master/Robust.Client/GameObjects/EntitySystems/AudioSystem.cs/#L587">View Source</a>
|
|
</span>
|
|
<a id="Robust_Client_GameObjects_AudioSystem_Play_" data-uid="Robust.Client.GameObjects.AudioSystem.Play*"></a>
|
|
<h4 id="Robust_Client_GameObjects_AudioSystem_Play_System_String_Robust_Shared_Player_Filter_Robust_Shared_Map_EntityCoordinates_System_Boolean_System_Nullable_Robust_Shared_Audio_AudioParams__" data-uid="Robust.Client.GameObjects.AudioSystem.Play(System.String,Robust.Shared.Player.Filter,Robust.Shared.Map.EntityCoordinates,System.Boolean,System.Nullable{Robust.Shared.Audio.AudioParams})">Play(String, Filter, EntityCoordinates, Boolean, Nullable<AudioParams>)</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 override IPlayingAudioStream Play(string filename, Filter playerFilter, EntityCoordinates coordinates, bool recordReplay, AudioParams? audioParams = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">filename</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Player.Filter.html">Filter</a></td>
|
|
<td><span class="parametername">playerFilter</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Map.EntityCoordinates.html">EntityCoordinates</a></td>
|
|
<td><span class="parametername">coordinates</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">recordReplay</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<a class="xref" href="../Robust.Shared/Robust.Shared.Audio.AudioParams.html">AudioParams</a>></td>
|
|
<td><span class="parametername">audioParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Audio.IPlayingAudioStream.html">IPlayingAudioStream</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_AudioSystem_PlayEntity_System_String_Robust_Shared_GameObjects_EntityUid_Robust_Shared_GameObjects_EntityUid_System_Nullable_Robust_Shared_Audio_AudioParams__.md&value=---%0Auid%3A%20Robust.Client.GameObjects.AudioSystem.PlayEntity(System.String%2CRobust.Shared.GameObjects.EntityUid%2CRobust.Shared.GameObjects.EntityUid%2CSystem.Nullable%7BRobust.Shared.Audio.AudioParams%7D)%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/RobustToolbox/blob/master/Robust.Client/GameObjects/EntitySystems/AudioSystem.cs/#L611">View Source</a>
|
|
</span>
|
|
<a id="Robust_Client_GameObjects_AudioSystem_PlayEntity_" data-uid="Robust.Client.GameObjects.AudioSystem.PlayEntity*"></a>
|
|
<h4 id="Robust_Client_GameObjects_AudioSystem_PlayEntity_System_String_Robust_Shared_GameObjects_EntityUid_Robust_Shared_GameObjects_EntityUid_System_Nullable_Robust_Shared_Audio_AudioParams__" data-uid="Robust.Client.GameObjects.AudioSystem.PlayEntity(System.String,Robust.Shared.GameObjects.EntityUid,Robust.Shared.GameObjects.EntityUid,System.Nullable{Robust.Shared.Audio.AudioParams})">PlayEntity(String, EntityUid, EntityUid, Nullable<AudioParams>)</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 override IPlayingAudioStream PlayEntity(string filename, EntityUid recipient, EntityUid uid, AudioParams? audioParams = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">filename</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.EntityUid.html">EntityUid</a></td>
|
|
<td><span class="parametername">recipient</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.EntityUid.html">EntityUid</a></td>
|
|
<td><span class="parametername">uid</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<a class="xref" href="../Robust.Shared/Robust.Shared.Audio.AudioParams.html">AudioParams</a>></td>
|
|
<td><span class="parametername">audioParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Audio.IPlayingAudioStream.html">IPlayingAudioStream</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_AudioSystem_PlayEntity_System_String_Robust_Shared_Players_ICommonSession_Robust_Shared_GameObjects_EntityUid_System_Nullable_Robust_Shared_Audio_AudioParams__.md&value=---%0Auid%3A%20Robust.Client.GameObjects.AudioSystem.PlayEntity(System.String%2CRobust.Shared.Players.ICommonSession%2CRobust.Shared.GameObjects.EntityUid%2CSystem.Nullable%7BRobust.Shared.Audio.AudioParams%7D)%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/RobustToolbox/blob/master/Robust.Client/GameObjects/EntitySystems/AudioSystem.cs/#L605">View Source</a>
|
|
</span>
|
|
<a id="Robust_Client_GameObjects_AudioSystem_PlayEntity_" data-uid="Robust.Client.GameObjects.AudioSystem.PlayEntity*"></a>
|
|
<h4 id="Robust_Client_GameObjects_AudioSystem_PlayEntity_System_String_Robust_Shared_Players_ICommonSession_Robust_Shared_GameObjects_EntityUid_System_Nullable_Robust_Shared_Audio_AudioParams__" data-uid="Robust.Client.GameObjects.AudioSystem.PlayEntity(System.String,Robust.Shared.Players.ICommonSession,Robust.Shared.GameObjects.EntityUid,System.Nullable{Robust.Shared.Audio.AudioParams})">PlayEntity(String, ICommonSession, EntityUid, Nullable<AudioParams>)</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 override IPlayingAudioStream PlayEntity(string filename, ICommonSession recipient, EntityUid uid, AudioParams? audioParams = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">filename</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Players.ICommonSession.html">ICommonSession</a></td>
|
|
<td><span class="parametername">recipient</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.EntityUid.html">EntityUid</a></td>
|
|
<td><span class="parametername">uid</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<a class="xref" href="../Robust.Shared/Robust.Shared.Audio.AudioParams.html">AudioParams</a>></td>
|
|
<td><span class="parametername">audioParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Audio.IPlayingAudioStream.html">IPlayingAudioStream</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_AudioSystem_PlayGlobal_System_String_Robust_Shared_GameObjects_EntityUid_System_Nullable_Robust_Shared_Audio_AudioParams__.md&value=---%0Auid%3A%20Robust.Client.GameObjects.AudioSystem.PlayGlobal(System.String%2CRobust.Shared.GameObjects.EntityUid%2CSystem.Nullable%7BRobust.Shared.Audio.AudioParams%7D)%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/RobustToolbox/blob/master/Robust.Client/GameObjects/EntitySystems/AudioSystem.cs/#L599">View Source</a>
|
|
</span>
|
|
<a id="Robust_Client_GameObjects_AudioSystem_PlayGlobal_" data-uid="Robust.Client.GameObjects.AudioSystem.PlayGlobal*"></a>
|
|
<h4 id="Robust_Client_GameObjects_AudioSystem_PlayGlobal_System_String_Robust_Shared_GameObjects_EntityUid_System_Nullable_Robust_Shared_Audio_AudioParams__" data-uid="Robust.Client.GameObjects.AudioSystem.PlayGlobal(System.String,Robust.Shared.GameObjects.EntityUid,System.Nullable{Robust.Shared.Audio.AudioParams})">PlayGlobal(String, EntityUid, Nullable<AudioParams>)</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 override IPlayingAudioStream PlayGlobal(string filename, EntityUid recipient, AudioParams? audioParams = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">filename</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.EntityUid.html">EntityUid</a></td>
|
|
<td><span class="parametername">recipient</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<a class="xref" href="../Robust.Shared/Robust.Shared.Audio.AudioParams.html">AudioParams</a>></td>
|
|
<td><span class="parametername">audioParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Audio.IPlayingAudioStream.html">IPlayingAudioStream</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_AudioSystem_PlayGlobal_System_String_Robust_Shared_Player_Filter_System_Boolean_System_Nullable_Robust_Shared_Audio_AudioParams__.md&value=---%0Auid%3A%20Robust.Client.GameObjects.AudioSystem.PlayGlobal(System.String%2CRobust.Shared.Player.Filter%2CSystem.Boolean%2CSystem.Nullable%7BRobust.Shared.Audio.AudioParams%7D)%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/RobustToolbox/blob/master/Robust.Client/GameObjects/EntitySystems/AudioSystem.cs/#L575">View Source</a>
|
|
</span>
|
|
<a id="Robust_Client_GameObjects_AudioSystem_PlayGlobal_" data-uid="Robust.Client.GameObjects.AudioSystem.PlayGlobal*"></a>
|
|
<h4 id="Robust_Client_GameObjects_AudioSystem_PlayGlobal_System_String_Robust_Shared_Player_Filter_System_Boolean_System_Nullable_Robust_Shared_Audio_AudioParams__" data-uid="Robust.Client.GameObjects.AudioSystem.PlayGlobal(System.String,Robust.Shared.Player.Filter,System.Boolean,System.Nullable{Robust.Shared.Audio.AudioParams})">PlayGlobal(String, Filter, Boolean, Nullable<AudioParams>)</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 override IPlayingAudioStream PlayGlobal(string filename, Filter playerFilter, bool recordReplay, AudioParams? audioParams = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">filename</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Player.Filter.html">Filter</a></td>
|
|
<td><span class="parametername">playerFilter</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">recordReplay</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<a class="xref" href="../Robust.Shared/Robust.Shared.Audio.AudioParams.html">AudioParams</a>></td>
|
|
<td><span class="parametername">audioParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Audio.IPlayingAudioStream.html">IPlayingAudioStream</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_AudioSystem_PlayGlobal_System_String_Robust_Shared_Players_ICommonSession_System_Nullable_Robust_Shared_Audio_AudioParams__.md&value=---%0Auid%3A%20Robust.Client.GameObjects.AudioSystem.PlayGlobal(System.String%2CRobust.Shared.Players.ICommonSession%2CSystem.Nullable%7BRobust.Shared.Audio.AudioParams%7D)%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/RobustToolbox/blob/master/Robust.Client/GameObjects/EntitySystems/AudioSystem.cs/#L593">View Source</a>
|
|
</span>
|
|
<a id="Robust_Client_GameObjects_AudioSystem_PlayGlobal_" data-uid="Robust.Client.GameObjects.AudioSystem.PlayGlobal*"></a>
|
|
<h4 id="Robust_Client_GameObjects_AudioSystem_PlayGlobal_System_String_Robust_Shared_Players_ICommonSession_System_Nullable_Robust_Shared_Audio_AudioParams__" data-uid="Robust.Client.GameObjects.AudioSystem.PlayGlobal(System.String,Robust.Shared.Players.ICommonSession,System.Nullable{Robust.Shared.Audio.AudioParams})">PlayGlobal(String, ICommonSession, Nullable<AudioParams>)</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 override IPlayingAudioStream PlayGlobal(string filename, ICommonSession recipient, AudioParams? audioParams = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">filename</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Players.ICommonSession.html">ICommonSession</a></td>
|
|
<td><span class="parametername">recipient</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<a class="xref" href="../Robust.Shared/Robust.Shared.Audio.AudioParams.html">AudioParams</a>></td>
|
|
<td><span class="parametername">audioParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Audio.IPlayingAudioStream.html">IPlayingAudioStream</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_AudioSystem_PlayPredicted_Robust_Shared_Audio_SoundSpecifier_Robust_Shared_GameObjects_EntityUid_System_Nullable_Robust_Shared_GameObjects_EntityUid__System_Nullable_Robust_Shared_Audio_AudioParams__.md&value=---%0Auid%3A%20Robust.Client.GameObjects.AudioSystem.PlayPredicted(Robust.Shared.Audio.SoundSpecifier%2CRobust.Shared.GameObjects.EntityUid%2CSystem.Nullable%7BRobust.Shared.GameObjects.EntityUid%7D%2CSystem.Nullable%7BRobust.Shared.Audio.AudioParams%7D)%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/RobustToolbox/blob/master/Robust.Client/GameObjects/EntitySystems/AudioSystem.cs/#L487">View Source</a>
|
|
</span>
|
|
<a id="Robust_Client_GameObjects_AudioSystem_PlayPredicted_" data-uid="Robust.Client.GameObjects.AudioSystem.PlayPredicted*"></a>
|
|
<h4 id="Robust_Client_GameObjects_AudioSystem_PlayPredicted_Robust_Shared_Audio_SoundSpecifier_Robust_Shared_GameObjects_EntityUid_System_Nullable_Robust_Shared_GameObjects_EntityUid__System_Nullable_Robust_Shared_Audio_AudioParams__" data-uid="Robust.Client.GameObjects.AudioSystem.PlayPredicted(Robust.Shared.Audio.SoundSpecifier,Robust.Shared.GameObjects.EntityUid,System.Nullable{Robust.Shared.GameObjects.EntityUid},System.Nullable{Robust.Shared.Audio.AudioParams})">PlayPredicted(SoundSpecifier, EntityUid, Nullable<EntityUid>, Nullable<AudioParams>)</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 override IPlayingAudioStream PlayPredicted(SoundSpecifier sound, EntityUid source, EntityUid? user, AudioParams? audioParams = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Audio.SoundSpecifier.html">SoundSpecifier</a></td>
|
|
<td><span class="parametername">sound</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.EntityUid.html">EntityUid</a></td>
|
|
<td><span class="parametername">source</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.EntityUid.html">EntityUid</a>></td>
|
|
<td><span class="parametername">user</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<a class="xref" href="../Robust.Shared/Robust.Shared.Audio.AudioParams.html">AudioParams</a>></td>
|
|
<td><span class="parametername">audioParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Audio.IPlayingAudioStream.html">IPlayingAudioStream</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_AudioSystem_PlayPredicted_Robust_Shared_Audio_SoundSpecifier_Robust_Shared_Map_EntityCoordinates_System_Nullable_Robust_Shared_GameObjects_EntityUid__System_Nullable_Robust_Shared_Audio_AudioParams__.md&value=---%0Auid%3A%20Robust.Client.GameObjects.AudioSystem.PlayPredicted(Robust.Shared.Audio.SoundSpecifier%2CRobust.Shared.Map.EntityCoordinates%2CSystem.Nullable%7BRobust.Shared.GameObjects.EntityUid%7D%2CSystem.Nullable%7BRobust.Shared.Audio.AudioParams%7D)%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/RobustToolbox/blob/master/Robust.Client/GameObjects/EntitySystems/AudioSystem.cs/#L495">View Source</a>
|
|
</span>
|
|
<a id="Robust_Client_GameObjects_AudioSystem_PlayPredicted_" data-uid="Robust.Client.GameObjects.AudioSystem.PlayPredicted*"></a>
|
|
<h4 id="Robust_Client_GameObjects_AudioSystem_PlayPredicted_Robust_Shared_Audio_SoundSpecifier_Robust_Shared_Map_EntityCoordinates_System_Nullable_Robust_Shared_GameObjects_EntityUid__System_Nullable_Robust_Shared_Audio_AudioParams__" data-uid="Robust.Client.GameObjects.AudioSystem.PlayPredicted(Robust.Shared.Audio.SoundSpecifier,Robust.Shared.Map.EntityCoordinates,System.Nullable{Robust.Shared.GameObjects.EntityUid},System.Nullable{Robust.Shared.Audio.AudioParams})">PlayPredicted(SoundSpecifier, EntityCoordinates, Nullable<EntityUid>, Nullable<AudioParams>)</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 override IPlayingAudioStream PlayPredicted(SoundSpecifier sound, EntityCoordinates coordinates, EntityUid? user, AudioParams? audioParams = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Audio.SoundSpecifier.html">SoundSpecifier</a></td>
|
|
<td><span class="parametername">sound</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Map.EntityCoordinates.html">EntityCoordinates</a></td>
|
|
<td><span class="parametername">coordinates</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.EntityUid.html">EntityUid</a>></td>
|
|
<td><span class="parametername">user</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<a class="xref" href="../Robust.Shared/Robust.Shared.Audio.AudioParams.html">AudioParams</a>></td>
|
|
<td><span class="parametername">audioParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Audio.IPlayingAudioStream.html">IPlayingAudioStream</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_AudioSystem_PlayStatic_System_String_Robust_Shared_GameObjects_EntityUid_Robust_Shared_Map_EntityCoordinates_System_Nullable_Robust_Shared_Audio_AudioParams__.md&value=---%0Auid%3A%20Robust.Client.GameObjects.AudioSystem.PlayStatic(System.String%2CRobust.Shared.GameObjects.EntityUid%2CRobust.Shared.Map.EntityCoordinates%2CSystem.Nullable%7BRobust.Shared.Audio.AudioParams%7D)%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/RobustToolbox/blob/master/Robust.Client/GameObjects/EntitySystems/AudioSystem.cs/#L623">View Source</a>
|
|
</span>
|
|
<a id="Robust_Client_GameObjects_AudioSystem_PlayStatic_" data-uid="Robust.Client.GameObjects.AudioSystem.PlayStatic*"></a>
|
|
<h4 id="Robust_Client_GameObjects_AudioSystem_PlayStatic_System_String_Robust_Shared_GameObjects_EntityUid_Robust_Shared_Map_EntityCoordinates_System_Nullable_Robust_Shared_Audio_AudioParams__" data-uid="Robust.Client.GameObjects.AudioSystem.PlayStatic(System.String,Robust.Shared.GameObjects.EntityUid,Robust.Shared.Map.EntityCoordinates,System.Nullable{Robust.Shared.Audio.AudioParams})">PlayStatic(String, EntityUid, EntityCoordinates, Nullable<AudioParams>)</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 override IPlayingAudioStream PlayStatic(string filename, EntityUid recipient, EntityCoordinates coordinates, AudioParams? audioParams = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">filename</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.EntityUid.html">EntityUid</a></td>
|
|
<td><span class="parametername">recipient</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Map.EntityCoordinates.html">EntityCoordinates</a></td>
|
|
<td><span class="parametername">coordinates</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<a class="xref" href="../Robust.Shared/Robust.Shared.Audio.AudioParams.html">AudioParams</a>></td>
|
|
<td><span class="parametername">audioParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Audio.IPlayingAudioStream.html">IPlayingAudioStream</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_AudioSystem_PlayStatic_System_String_Robust_Shared_Players_ICommonSession_Robust_Shared_Map_EntityCoordinates_System_Nullable_Robust_Shared_Audio_AudioParams__.md&value=---%0Auid%3A%20Robust.Client.GameObjects.AudioSystem.PlayStatic(System.String%2CRobust.Shared.Players.ICommonSession%2CRobust.Shared.Map.EntityCoordinates%2CSystem.Nullable%7BRobust.Shared.Audio.AudioParams%7D)%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/RobustToolbox/blob/master/Robust.Client/GameObjects/EntitySystems/AudioSystem.cs/#L617">View Source</a>
|
|
</span>
|
|
<a id="Robust_Client_GameObjects_AudioSystem_PlayStatic_" data-uid="Robust.Client.GameObjects.AudioSystem.PlayStatic*"></a>
|
|
<h4 id="Robust_Client_GameObjects_AudioSystem_PlayStatic_System_String_Robust_Shared_Players_ICommonSession_Robust_Shared_Map_EntityCoordinates_System_Nullable_Robust_Shared_Audio_AudioParams__" data-uid="Robust.Client.GameObjects.AudioSystem.PlayStatic(System.String,Robust.Shared.Players.ICommonSession,Robust.Shared.Map.EntityCoordinates,System.Nullable{Robust.Shared.Audio.AudioParams})">PlayStatic(String, ICommonSession, EntityCoordinates, Nullable<AudioParams>)</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 override IPlayingAudioStream PlayStatic(string filename, ICommonSession recipient, EntityCoordinates coordinates, AudioParams? audioParams = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">filename</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Players.ICommonSession.html">ICommonSession</a></td>
|
|
<td><span class="parametername">recipient</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Map.EntityCoordinates.html">EntityCoordinates</a></td>
|
|
<td><span class="parametername">coordinates</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<a class="xref" href="../Robust.Shared/Robust.Shared.Audio.AudioParams.html">AudioParams</a>></td>
|
|
<td><span class="parametername">audioParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Audio.IPlayingAudioStream.html">IPlayingAudioStream</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_AudioSystem_Shutdown.md&value=---%0Auid%3A%20Robust.Client.GameObjects.AudioSystem.Shutdown%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/RobustToolbox/blob/master/Robust.Client/GameObjects/EntitySystems/AudioSystem.cs/#L64">View Source</a>
|
|
</span>
|
|
<a id="Robust_Client_GameObjects_AudioSystem_Shutdown_" data-uid="Robust.Client.GameObjects.AudioSystem.Shutdown*"></a>
|
|
<h4 id="Robust_Client_GameObjects_AudioSystem_Shutdown" data-uid="Robust.Client.GameObjects.AudioSystem.Shutdown">Shutdown()</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 override void Shutdown()</code></pre>
|
|
</div>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.EntitySystem.html#Robust_Shared_GameObjects_EntitySystem_Shutdown">EntitySystem.Shutdown()</a></div>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.IEntitySystem.html">IEntitySystem</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.IEntityEventSubscriber.html">IEntityEventSubscriber</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="../Robust.Shared/Robust.Shared.IoC.IPostInjectInit.html">IPostInjectInit</a>
|
|
</div>
|
|
</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/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_AudioSystem.md&value=---%0Auid%3A%20Robust.Client.GameObjects.AudioSystem%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/RobustToolbox/blob/master/Robust.Client/GameObjects/EntitySystems/AudioSystem.cs/#L29" 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>
|