Files
space-station-14/api/Content.Client/Content.Client.Administration.UI.CustomControls.PlayerListControl.html
2023-10-08 01:38:46 +00:00

372 lines
21 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 PlayerListControl
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class PlayerListControl
">
<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.Administration.UI.CustomControls.PlayerListControl">
<h1 id="Content_Client_Administration_UI_CustomControls_PlayerListControl" data-uid="Content.Client.Administration.UI.CustomControls.PlayerListControl" class="text-break">Class PlayerListControl
</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"><span class="xref">Robust.Client.UserInterface.Control</span></div>
<div class="level2"><span class="xref">Robust.Client.UserInterface.Controls.Container</span></div>
<div class="level3"><span class="xref">Robust.Client.UserInterface.Controls.BoxContainer</span></div>
<div class="level4"><span class="xref">PlayerListControl</span></div>
</div>
<div class="inheritedMembers">
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Content.Client.Administration.UI.CustomControls.html">Content.Client.Administration.UI.CustomControls</a></h6>
<h6><strong>Assembly</strong>: Content.Client.dll</h6>
<h5 id="Content_Client_Administration_UI_CustomControls_PlayerListControl_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class PlayerListControl : BoxContainer</code></pre>
</div>
<h3 id="constructors">Constructors
</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_Administration_UI_CustomControls_PlayerListControl__ctor.md&amp;value=---%0Auid%3A%20Content.Client.Administration.UI.CustomControls.PlayerListControl.%23ctor%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/Administration/UI/CustomControls/PlayerListControl.xaml.cs/#L34">View Source</a>
</span>
<a id="Content_Client_Administration_UI_CustomControls_PlayerListControl__ctor_" data-uid="Content.Client.Administration.UI.CustomControls.PlayerListControl.#ctor*"></a>
<h4 id="Content_Client_Administration_UI_CustomControls_PlayerListControl__ctor" data-uid="Content.Client.Administration.UI.CustomControls.PlayerListControl.#ctor">PlayerListControl()</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 PlayerListControl()</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_Administration_UI_CustomControls_PlayerListControl_Comparison.md&amp;value=---%0Auid%3A%20Content.Client.Administration.UI.CustomControls.PlayerListControl.Comparison%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/Administration/UI/CustomControls/PlayerListControl.xaml.cs/#L29">View Source</a>
</span>
<h4 id="Content_Client_Administration_UI_CustomControls_PlayerListControl_Comparison" data-uid="Content.Client.Administration.UI.CustomControls.PlayerListControl.Comparison">Comparison</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 Comparison&lt;PlayerInfo&gt;? Comparison</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.Nullable</span>&lt;<span class="xref">Comparison</span>&lt;<span class="xref">PlayerInfo</span>&gt;&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_Administration_UI_CustomControls_PlayerListControl_OverrideText.md&amp;value=---%0Auid%3A%20Content.Client.Administration.UI.CustomControls.PlayerListControl.OverrideText%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/Administration/UI/CustomControls/PlayerListControl.xaml.cs/#L28">View Source</a>
</span>
<h4 id="Content_Client_Administration_UI_CustomControls_PlayerListControl_OverrideText" data-uid="Content.Client.Administration.UI.CustomControls.PlayerListControl.OverrideText">OverrideText</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 Func&lt;PlayerInfo, string, string&gt;? OverrideText</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.Nullable</span>&lt;<span class="xref">Func</span>&lt;<span class="xref">PlayerInfo</span>, <span class="xref">System.String</span>, <span class="xref">System.String</span>&gt;&gt;</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_Administration_UI_CustomControls_PlayerListControl_PlayerInfo.md&amp;value=---%0Auid%3A%20Content.Client.Administration.UI.CustomControls.PlayerListControl.PlayerInfo%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/Administration/UI/CustomControls/PlayerListControl.xaml.cs/#L26">View Source</a>
</span>
<a id="Content_Client_Administration_UI_CustomControls_PlayerListControl_PlayerInfo_" data-uid="Content.Client.Administration.UI.CustomControls.PlayerListControl.PlayerInfo*"></a>
<h4 id="Content_Client_Administration_UI_CustomControls_PlayerListControl_PlayerInfo" data-uid="Content.Client.Administration.UI.CustomControls.PlayerListControl.PlayerInfo">PlayerInfo</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 IReadOnlyList&lt;PlayerInfo&gt; PlayerInfo { 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">IReadOnlyList</span>&lt;<span class="xref">PlayerInfo</span>&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_Administration_UI_CustomControls_PlayerListControl_PopulateList_System_Nullable_IReadOnlyList_PlayerInfo___.md&amp;value=---%0Auid%3A%20Content.Client.Administration.UI.CustomControls.PlayerListControl.PopulateList(System.Nullable%7BIReadOnlyList%7BPlayerInfo%7D%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/space-station-14/blob/master/Content.Client/Administration/UI/CustomControls/PlayerListControl.xaml.cs/#L92">View Source</a>
</span>
<a id="Content_Client_Administration_UI_CustomControls_PlayerListControl_PopulateList_" data-uid="Content.Client.Administration.UI.CustomControls.PlayerListControl.PopulateList*"></a>
<h4 id="Content_Client_Administration_UI_CustomControls_PlayerListControl_PopulateList_System_Nullable_IReadOnlyList_PlayerInfo___" data-uid="Content.Client.Administration.UI.CustomControls.PlayerListControl.PopulateList(System.Nullable{IReadOnlyList{PlayerInfo}})">PopulateList(Nullable&lt;IReadOnlyList&lt;PlayerInfo&gt;&gt;)</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 PopulateList(IReadOnlyList&lt;PlayerInfo&gt;? players = 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.Nullable</span>&lt;<span class="xref">IReadOnlyList</span>&lt;<span class="xref">PlayerInfo</span>&gt;&gt;</td>
<td><span class="parametername">players</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_Administration_UI_CustomControls_PlayerListControl_StopFiltering.md&amp;value=---%0Auid%3A%20Content.Client.Administration.UI.CustomControls.PlayerListControl.StopFiltering%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/Administration/UI/CustomControls/PlayerListControl.xaml.cs/#L67">View Source</a>
</span>
<a id="Content_Client_Administration_UI_CustomControls_PlayerListControl_StopFiltering_" data-uid="Content.Client.Administration.UI.CustomControls.PlayerListControl.StopFiltering*"></a>
<h4 id="Content_Client_Administration_UI_CustomControls_PlayerListControl_StopFiltering" data-uid="Content.Client.Administration.UI.CustomControls.PlayerListControl.StopFiltering">StopFiltering()</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 StopFiltering()</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_Administration_UI_CustomControls_PlayerListControl_OnSelectionChanged.md&amp;value=---%0Auid%3A%20Content.Client.Administration.UI.CustomControls.PlayerListControl.OnSelectionChanged%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/Administration/UI/CustomControls/PlayerListControl.xaml.cs/#L25">View Source</a>
</span>
<h4 id="Content_Client_Administration_UI_CustomControls_PlayerListControl_OnSelectionChanged" data-uid="Content.Client.Administration.UI.CustomControls.PlayerListControl.OnSelectionChanged">OnSelectionChanged</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&lt;PlayerInfo?&gt;? OnSelectionChanged</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>&lt;<span class="xref">Action</span>&lt;<span class="xref">System.Nullable</span>&lt;<span class="xref">PlayerInfo</span>&gt;&gt;&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="extensionmethods">Extension Methods</h3>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_GetControlOfType__1_Robust_Client_UserInterface_Control_">ControlExtension.GetControlOfType&lt;T&gt;(Control)</a>
</div>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_GetControlOfType__1_Robust_Client_UserInterface_Control_System_String_">ControlExtension.GetControlOfType&lt;T&gt;(Control, String)</a>
</div>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_GetControlOfType__1_Robust_Client_UserInterface_Control_System_Boolean_">ControlExtension.GetControlOfType&lt;T&gt;(Control, Boolean)</a>
</div>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_GetControlOfType__1_Robust_Client_UserInterface_Control_System_String_System_Boolean_">ControlExtension.GetControlOfType&lt;T&gt;(Control, String, Boolean)</a>
</div>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_GetSearchableControls_Robust_Client_UserInterface_Control_System_Boolean_">ControlExtension.GetSearchableControls(Control, Boolean)</a>
</div>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_ChildrenContainText_Robust_Client_UserInterface_Control_System_String_">ControlExtension.ChildrenContainText(Control, String)</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/space-station-14/new/master/apiSpec/new?filename=Content_Client_Administration_UI_CustomControls_PlayerListControl.md&amp;value=---%0Auid%3A%20Content.Client.Administration.UI.CustomControls.PlayerListControl%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/Administration/UI/CustomControls/PlayerListControl.xaml.cs/#L17" 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>