Files
space-station-14/api/Content.Client/Content.Client.Light.Components.LightBehaviourComponent.html
2023-10-08 01:38:46 +00:00

400 lines
22 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 LightBehaviourComponent
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class LightBehaviourComponent
">
<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.Light.Components.LightBehaviourComponent">
<h1 id="Content_Client_Light_Components_LightBehaviourComponent" data-uid="Content.Client.Light.Components.LightBehaviourComponent" class="text-break">Class LightBehaviourComponent
</h1>
<div class="markdown level0 summary"><p>A component which applies a specific behaviour to a PointLightComponent on its owner.</p>
</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.Light.Components.SharedLightBehaviourComponent.html">SharedLightBehaviourComponent</a></div>
<div class="level2"><span class="xref">LightBehaviourComponent</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">Robust.Shared.Serialization.ISerializationHooks</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Content.Client.Light.Components.html">Content.Client.Light.Components</a></h6>
<h6><strong>Assembly</strong>: Content.Client.dll</h6>
<h5 id="Content_Client_Light_Components_LightBehaviourComponent_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class LightBehaviourComponent : SharedLightBehaviourComponent, ISerializationHooks</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_Light_Components_LightBehaviourComponent_Animations.md&amp;value=---%0Auid%3A%20Content.Client.Light.Components.LightBehaviourComponent.Animations%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/Light/Components/LightBehaviourComponent.cs/#L387">View Source</a>
</span>
<h4 id="Content_Client_Light_Components_LightBehaviourComponent_Animations" data-uid="Content.Client.Light.Components.LightBehaviourComponent.Animations">Animations</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 readonly List&lt;LightBehaviourComponent.AnimationContainer&gt; Animations</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>&lt;<a class="xref" href="Content.Client.Light.Components.LightBehaviourComponent.AnimationContainer.html">LightBehaviourComponent.AnimationContainer</a>&gt;</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_Light_Components_LightBehaviourComponent_Behaviours.md&amp;value=---%0Auid%3A%20Content.Client.Light.Components.LightBehaviourComponent.Behaviours%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/Light/Components/LightBehaviourComponent.cs/#L384">View Source</a>
</span>
<h4 id="Content_Client_Light_Components_LightBehaviourComponent_Behaviours" data-uid="Content.Client.Light.Components.LightBehaviourComponent.Behaviours">Behaviours</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 List&lt;LightBehaviourAnimationTrack&gt; Behaviours</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>&lt;<a class="xref" href="Content.Client.Light.Components.LightBehaviourAnimationTrack.html">LightBehaviourAnimationTrack</a>&gt;</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_Light_Components_LightBehaviourComponent_AddNewLightBehaviour_Content_Client_Light_Components_LightBehaviourAnimationTrack_System_Boolean_.md&amp;value=---%0Auid%3A%20Content.Client.Light.Components.LightBehaviourComponent.AddNewLightBehaviour(Content.Client.Light.Components.LightBehaviourAnimationTrack%2CSystem.Boolean)%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/Light/Components/LightBehaviourComponent.cs/#L519">View Source</a>
</span>
<a id="Content_Client_Light_Components_LightBehaviourComponent_AddNewLightBehaviour_" data-uid="Content.Client.Light.Components.LightBehaviourComponent.AddNewLightBehaviour*"></a>
<h4 id="Content_Client_Light_Components_LightBehaviourComponent_AddNewLightBehaviour_Content_Client_Light_Components_LightBehaviourAnimationTrack_System_Boolean_" data-uid="Content.Client.Light.Components.LightBehaviourComponent.AddNewLightBehaviour(Content.Client.Light.Components.LightBehaviourAnimationTrack,System.Boolean)">AddNewLightBehaviour(LightBehaviourAnimationTrack, Boolean)</h4>
<div class="markdown level1 summary"><p>Add a new light behaviour to the component and start it immediately unless otherwise specified.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void AddNewLightBehaviour(LightBehaviourAnimationTrack behaviour, bool playImmediately = true)</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="Content.Client.Light.Components.LightBehaviourAnimationTrack.html">LightBehaviourAnimationTrack</a></td>
<td><span class="parametername">behaviour</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">playImmediately</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_Light_Components_LightBehaviourComponent_HasRunningBehaviours.md&amp;value=---%0Auid%3A%20Content.Client.Light.Components.LightBehaviourComponent.HasRunningBehaviours%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/Light/Components/LightBehaviourComponent.cs/#L506">View Source</a>
</span>
<a id="Content_Client_Light_Components_LightBehaviourComponent_HasRunningBehaviours_" data-uid="Content.Client.Light.Components.LightBehaviourComponent.HasRunningBehaviours*"></a>
<h4 id="Content_Client_Light_Components_LightBehaviourComponent_HasRunningBehaviours" data-uid="Content.Client.Light.Components.LightBehaviourComponent.HasRunningBehaviours">HasRunningBehaviours()</h4>
<div class="markdown level1 summary"><p>Checks if at least one behaviour is running.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool HasRunningBehaviours()</code></pre>
</div>
<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><span class="xref">System.Boolean</span></td>
<td><p>Whether at least one behaviour is running, false if none is.</p>
</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_Light_Components_LightBehaviourComponent_StartLightBehaviour_System_String_.md&amp;value=---%0Auid%3A%20Content.Client.Light.Components.LightBehaviourComponent.StartLightBehaviour(System.String)%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/Light/Components/LightBehaviourComponent.cs/#L432">View Source</a>
</span>
<a id="Content_Client_Light_Components_LightBehaviourComponent_StartLightBehaviour_" data-uid="Content.Client.Light.Components.LightBehaviourComponent.StartLightBehaviour*"></a>
<h4 id="Content_Client_Light_Components_LightBehaviourComponent_StartLightBehaviour_System_String_" data-uid="Content.Client.Light.Components.LightBehaviourComponent.StartLightBehaviour(System.String)">StartLightBehaviour(String)</h4>
<div class="markdown level1 summary"><p>Start animating a light behaviour with the specified ID. If the specified ID is empty, it will start animating all light behaviour entries.
If specified light behaviours are already animating, calling this does nothing.
Multiple light behaviours can have the same ID.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void StartLightBehaviour(string id = &quot;&quot;)</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">id</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_Light_Components_LightBehaviourComponent_StopLightBehaviour_System_String_System_Boolean_System_Boolean_.md&amp;value=---%0Auid%3A%20Content.Client.Light.Components.LightBehaviourComponent.StopLightBehaviour(System.String%2CSystem.Boolean%2CSystem.Boolean)%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/Light/Components/LightBehaviourComponent.cs/#L461">View Source</a>
</span>
<a id="Content_Client_Light_Components_LightBehaviourComponent_StopLightBehaviour_" data-uid="Content.Client.Light.Components.LightBehaviourComponent.StopLightBehaviour*"></a>
<h4 id="Content_Client_Light_Components_LightBehaviourComponent_StopLightBehaviour_System_String_System_Boolean_System_Boolean_" data-uid="Content.Client.Light.Components.LightBehaviourComponent.StopLightBehaviour(System.String,System.Boolean,System.Boolean)">StopLightBehaviour(String, Boolean, Boolean)</h4>
<div class="markdown level1 summary"><p>If any light behaviour with the specified ID is animating, then stop it.
If no ID is specified then all light behaviours will be stopped.
Multiple light behaviours can have the same ID.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void StopLightBehaviour(string id = &quot;&quot;, bool removeBehaviour = false, bool resetToOriginalSettings = false)</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">id</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">removeBehaviour</span></td>
<td><p>Should the behaviour(s) also be removed permanently?</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">resetToOriginalSettings</span></td>
<td><p>Should the light have its original settings applied?</p>
</td>
</tr>
</tbody>
</table>
<h3 id="eii">Explicit Interface Implementations
</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_Light_Components_LightBehaviourComponent_Robust_Shared_Serialization_ISerializationHooks_AfterDeserialization.md&amp;value=---%0Auid%3A%20Content.Client.Light.Components.LightBehaviourComponent.Robust%23Shared%23Serialization%23ISerializationHooks%23AfterDeserialization%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/Light/Components/LightBehaviourComponent.cs/#L392">View Source</a>
</span>
<a id="Content_Client_Light_Components_LightBehaviourComponent_Robust_Shared_Serialization_ISerializationHooks_AfterDeserialization_" data-uid="Content.Client.Light.Components.LightBehaviourComponent.Robust#Shared#Serialization#ISerializationHooks#AfterDeserialization*"></a>
<h4 id="Content_Client_Light_Components_LightBehaviourComponent_Robust_Shared_Serialization_ISerializationHooks_AfterDeserialization" data-uid="Content.Client.Light.Components.LightBehaviourComponent.Robust#Shared#Serialization#ISerializationHooks#AfterDeserialization">ISerializationHooks.AfterDeserialization()</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">void ISerializationHooks.AfterDeserialization()</code></pre>
</div>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">Robust.Shared.Serialization.ISerializationHooks</span>
</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/space-station-14/new/master/apiSpec/new?filename=Content_Client_Light_Components_LightBehaviourComponent.md&amp;value=---%0Auid%3A%20Content.Client.Light.Components.LightBehaviourComponent%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/Light/Components/LightBehaviourComponent.cs/#L359" 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>