Although proper testing should be performed prior to attempting to add the deployable to this toolbox,
three tests are administered to determine whether space is available prior to insertion.</p><divclass="fullcomment"><divclass="comment cmt"><p>Manage the provided deployable.<br>
<br>
Although proper testing should be performed prior to attempting to add the deployable to this toolbox,
three tests are administered to determine whether space is available prior to insertion.
The first two tests check for available space in the category count and in the unit count
and the third test checks whether the deployable is already being managed by this toolbox.
No changes should occur if the deployable is not properly added.</p></div><dlclass="paramcmts block"><dtclass="param">obj</dt><ddclass="cmt"><p>the deployable</p></dd><dt>returns</dt><ddclass="cmt"><p><code>true</code>, if the deployable is added;
<code>false</code>, otherwise</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.objects.avatar.DeployableToolbox#AddOverLimit"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="AddOverLimit(obj:net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable):Boolean"></a><aid="AddOverLimit(AcceptableDeployable):Boolean"></a><spanclass="permalink"><ahref="../../../../net/psforever/objects/avatar/DeployableToolbox.html#AddOverLimit(obj:net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable):Boolean"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">AddOverLimit</span><spanclass="params">(<spanname="obj">obj: <ahref="DeployableToolbox$.html#AcceptableDeployable=net.psforever.objects.ce.Deployable"name="net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable"id="net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable"class="extmbr">AcceptableDeployable</a></span>)</span><spanclass="result">: <spanname="scala.Boolean"class="extype">Boolean</span></span></span><pclass="shortcomment cmt">Manage the provided deployable, the maximum number of governable units be damned.</p><divclass="fullcomment"><divclass="comment cmt"><p>Manage the provided deployable, the maximum number of governable units be damned.
It still needs to be a unique unit of a governable deployable type, however.</p></div><dlclass="paramcmts block"><dtclass="param">obj</dt><ddclass="cmt"><p>the deployable</p></dd><dt>returns</dt><ddclass="cmt"><p><code>true</code>, if the deployable is added;
<code>false</code>, otherwise</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.objects.avatar.DeployableToolbox#Available"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="Available(obj:net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable):Boolean"></a><aid="Available(AcceptableDeployable):Boolean"></a><spanclass="permalink"><ahref="../../../../net/psforever/objects/avatar/DeployableToolbox.html#Available(obj:net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable):Boolean"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">Available</span><spanclass="params">(<spanname="obj">obj: <ahref="DeployableToolbox$.html#AcceptableDeployable=net.psforever.objects.ce.Deployable"name="net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable"id="net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable"class="extmbr">AcceptableDeployable</a></span>)</span><spanclass="result">: <spanname="scala.Boolean"class="extype">Boolean</span></span></span><pclass="shortcomment cmt">Determine if the given deployable can be managed by this toolbox
by testing if the specific deployable list and the deployable category list have available slots.</p><divclass="fullcomment"><divclass="comment cmt"><p>Determine if the given deployable can be managed by this toolbox
by testing if the specific deployable list and the deployable category list have available slots.
In this case, a "slot" is merely the difference between the current count is less than the maximum count.</p></div><dlclass="paramcmts block"><dtclass="param">obj</dt><ddclass="cmt"><p>the deployable</p></dd><dt>returns</dt><ddclass="cmt"><p><code>true</code>, if the deployable can be added to the support lists and counted;
<code>false</code>, otherwise</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.objects.avatar.DeployableToolbox#Category"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="Category(filter:net.psforever.objects.ce.DeployableCategory.Value):List[net.psforever.types.PlanetSideGUID]"></a><aid="Category(ce.DeployableCategory.Value):List[PlanetSideGUID]"></a><spanclass="permalink"><ahref="../../../../net/psforever/objects/avatar/DeployableToolbox.html#Category(filter:net.psforever.objects.ce.DeployableCategory.Value):List[net.psforever.types.PlanetSideGUID]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">Category</span><spanclass="params">(<spanname="filter">filter: <ahref="../ce/DeployableCategory$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable"name="net.psforever.objects.ce.DeployableCategory.Value"id="net.psforever.objects.ce.DeployableCategory.Value"class="extmbr">ce.DeployableCategory.Value</a></span>)</span><spanclass="result">: <spanname="scala.List"class="extype">List</span>[<ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a>]</span></span><pclass="shortcomment cmt">Reference all managed deployables in the same category.</p><divclass="fullcomment"><divclass="comment cmt"><p>Reference all managed deployables in the same category.</p></div><dlclass="paramcmts block"><dtclass="param">filter</dt><ddclass="cmt"><p>the type of deployable</p></dd><dt>returns</dt><ddclass="cmt"><p>a list of globally unique identifiers that should be valid for the current zone</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.objects.avatar.DeployableToolbox#Category"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="Category(filter:net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable):List[net.psforever.types.PlanetSideGUID]"></a><aid="Category(AcceptableDeployable):List[PlanetSideGUID]"></a><spanclass="permalink"><ahref="../../../../net/psforever/objects/avatar/DeployableToolbox.html#Category(filter:net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable):List[net.psforever.types.PlanetSideGUID]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">Category</span><spanclass="params">(<spanname="filter">filter: <ahref="DeployableToolbox$.html#AcceptableDeployable=net.psforever.objects.ce.Deployable"name="net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable"id="net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable"class="extmbr">AcceptableDeployable</a></span>)</span><spanclass="result">: <spanname="scala.List"class="extype">List</span>[<ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a>]</span></span><pclass="shortcomment cmt">Reference all managed deployables in the same category as an example deployable.</p><divclass="fullcomment"><divclass="comment cmt"><p>Reference all managed deployables in the same category as an example deployable.</p></div><dlclass="paramcmts block"><dtclass="param">filter</dt><ddclass="cmt"><p>the example deployable</p></dd><dt>returns</dt><ddclass="cmt"><p>a list of globally unique identifiers that should be valid for the current zone</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.objects.avatar.DeployableToolbox#Clear"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="Clear():List[net.psforever.types.PlanetSideGUID]"></a><aid="Clear():List[PlanetSideGUID]"></a><spanclass="permalink"><ahref="../../../../net/psforever/objects/avatar/DeployableToolbox.html#Clear():List[n
by determining whether or not it is already being managed by this toolbox.</p><divclass="fullcomment"><divclass="comment cmt"><p>Check if this deployable is already being managed by the toolbox
by determining whether or not it is already being managed by this toolbox.</p></div><dlclass="paramcmts block"><dtclass="param">obj</dt><ddclass="cmt"><p>the deployable</p></dd><dt>returns</dt><ddclass="cmt"><p><code>true</code>, if the deployable can be found in one of the lists;
<code>false</code>, otherwise</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.objects.avatar.DeployableToolbox#CountCategory"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="CountCategory(item:net.psforever.objects.ce.DeployedItem.Value):(Int,Int)"></a><aid="CountCategory(ce.DeployedItem.Value):(Int,Int)"></a><spanclass="permalink"><ahref="../../../../net/psforever/objects/avatar/DeployableToolbox.html#CountCategory(item:net.psforever.objects.ce.DeployedItem.Value):(Int,Int)"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">CountCategory</span><spanclass="params">(<spanname="item">item: <ahref="../ce/DeployedItem$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable"name="net.psforever.objects.ce.DeployedItem.Value"id="net.psforever.objects.ce.DeployedItem.Value"class="extmbr">ce.DeployedItem.Value</a></span>)</span><spanclass="result">: (<spanname="scala.Int"class="extype">Int</span>, <spanname="scala.Int"class="extype">Int</span>)</span></span><pclass="shortcomment cmt">Check the current capacity for the same category of deployable as the example.</p><divclass="fullcomment"><divclass="comment cmt"><p>Check the current capacity for the same category of deployable as the example.</p></div><dlclass="paramcmts block"><dtclass="param">item</dt><ddclass="cmt"><p>the example deployable</p></dd><dt>returns</dt><ddclass="cmt"><p>the current quantity of deployables and the maximum number</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.objects.avatar.DeployableToolbox#CountDeployable"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="CountDeployable(item:net.psforever.objects.ce.DeployedItem.Value):(Int,Int)"></a><aid="CountDeployable(ce.DeployedItem.Value):(Int,Int)"></a><spanclass="permalink"><ahref="../../../../net/psforever/objects/avatar/DeployableToolbox.html#CountDeployable(item:net.psforever.objects.ce.DeployedItem.Value):(Int,Int)"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">CountDeployable</span><spanclass="params">(<spanname="item">item: <ahref="../ce/DeployedItem$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable"name="net.psforever.objects.ce.DeployedItem.Value"id="net.psforever.objects.ce.DeployedItem.Value"class="extmbr">ce.DeployedItem.Value</a></span>)</span><spanclass="result">: (<spanname="scala.Int"class="extype">Int</span>, <spanname="scala.Int"class="extype">Int</span>)</span></span><pclass="shortcomment cmt">Check the current capacity for the same type of deployable as the example.</p><divclass="fullcomment"><divclass="comment cmt"><p>Check the current capacity for the same type of deployable as the example.</p></div><dlclass="paramcmts block"><dtclass="param">item</dt><ddclass="cmt"><p>the example deployable</p></dd><dt>returns</dt><ddclass="cmt"><p>the current quantity of deployables and the maximum number</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.objects.avatar.DeployableToolbox#Deployables"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="Deployables(filter:net.psforever.objects.ce.DeployedItem.Value):List[net.psforever.types.PlanetSideGUID]"></a><aid="Deployables(ce.DeployedItem.Value):List[PlanetSideGUID]"></a><spanclass="permalink"><ahref="../../../../net/psforever/objects/avatar/DeployableToolbox.html#Deployables(filter:net.psforever.objects.ce.DeployedItem.Value):List[net.psforever.types.PlanetSideGUID]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">Deployables</span><spanclass="params">(<spanname="filter">filter: <ahref="../ce/D
The only test performed is whether there is any valid deployable managed for the category.</p></div><dlclass="paramcmts block"><dtclass="param">category</dt><ddclass="cmt"><p>the target category</p></dd><dt>returns</dt><ddclass="cmt"><p>any deployable that is found</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.objects.avatar.DeployableToolbox#DisplaceFirst"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="DisplaceFirst(obj:net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable,rule:net.psforever.objects.ce.Deployable=>Boolean):Option[net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable]"></a><aid="DisplaceFirst(AcceptableDeployable,(Deployable)=>Boolean):Option[AcceptableDeployable]"></a><spanclass="permalink"><ahref="../../../../net/psforever/objects/avatar/DeployableToolbox.html#DisplaceFirst(obj:net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable,rule:net.psforever.objects.ce.Deployable=>Boolean):Option[net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">DisplaceFirst</span><spanclass="params">(<spanname="obj">obj: <ahref="DeployableToolbox$.html#AcceptableDeployable=net.psforever.objects.ce.Deployable"name="net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable"id="net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable"class="extmbr">AcceptableDeployable</a></span>, <spanname="rule">rule: (<ahref="../ce/Deployable.html"name="net.psforever.objects.ce.Deployable"id="net.psforever.objects.ce.Deployable"class="extype">Deployable</a>) =><spanname="scala.Boolean"class="extype">Boolean</span></span>)</span><spanclass="result">: <spanname="scala.Option"class="extype">Option</span>[<ahref="DeployableToolbox$.html#AcceptableDeployable=net.psforever.objects.ce.Deployable"name="net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable"id="net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable"class="extmbr">AcceptableDeployable</a>]</span></span><pclass="shortcomment cmt">Remove the first managed deployable that satisfies a test and belongs to the same category as the example.</p><divclass="fullcomment"><divclass="comment cmt"><p>Remove the first managed deployable that satisfies a test and belongs to the same category as the example.
The only test performed is whether there is any valid deployable managed for the category.</p></div><dlclass="paramcmts block"><dtclass="param">obj</dt><ddclass="cmt"><p>the example deployable</p></dd><dtclass="param">rule</dt><ddclass="cmt"><p>the testing rule for determining a valid deployable</p></dd><dt>returns</dt><ddclass="cmt"><p>any deployable that is found</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.objects.avatar.DeployableToolbox#DisplaceFirst"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="DisplaceFirst(obj:net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable):Option[net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable]"></a><aid="DisplaceFirst(AcceptableDeployable):Option[AcceptableDeployable]"></a><spanclass="permalink"><ahref="../../../../net/psforever/objects/avatar/DeployableToolbox.html#DisplaceFirst(obj:net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable):Option[net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">DisplaceFirst</span><spanclass="params">(<spanname="obj">obj: <ahref="DeployableToolbox$.html#AcceptableDeployable=net.psforever.objects.ce.Deployable"name="net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable"id="net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable"class="extmbr">AcceptableDeployable</a></span>)</span><spanclass="result">: <spanname="scala.Option"class="extype">Option</span>[<ahref="DeployableToolbox$.html#AcceptableDeployable=net.psforever.objects.ce.Deployable"name="net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable"id="net.psforever.objects.avatar.DeployableToolbox.AcceptableDeployable"class="extmbr">AcceptableDeployable</a>]</span></span><pclass="shortcomment cmt">Remove the first managed deployable that matches the same type of deployable as the example.</p><divclass="fullcomment"><divclass="comment cmt"><p>Remove the first managed deployable that matches the same type of deployable as the example.
The explicit tests is defined to find the first deployable whose type matches.</p></div><dlclass="paramcmts block"><dtclass="param">obj</dt><ddclass="cmt"><p>the example deployable</p></dd><dt>returns</dt><ddclass="cmt"><p>any deployable that is found</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.objects.avatar.DeployableToolbox#Initialize"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="Initialize(certifications:Set[net.psforever.objects.avatar.Certification]):Boolean"></a><aid="Initialize(Set[Certification]):Boolean"></a><spanclass="permalink"><ahref="../../../../net/psforever/objects/avatar/DeployableToolbox.html#Initialize(certifications:Set[net.psforever.objects.avatar.Certification]):Boolean"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">Initialize</span><spanclass="params">(<spanname="certifications">certifications: <spanname="scala.Predef.Set"class="extype">Set</span>[<ahref="Certification.html"name="net.psforever.objects.avatar.Certification"id="net.psforever.objects.avatar.Certification"class="extype">Certification</a>]</span>)</span><spanclass="result">: <spanname="scala.Boolean"class="extype">Boolean</span></span></span><pclass="shortcomment cmt">Set up the initial deployable counts by providing certification values to be used in category and unit selection.</p><divclass="fullcomment"><divclass="comment cmt"><p>Set up the initial deployable counts by providing certification values to be used in category and unit selection.
</p></div><dlclass="paramcmts block"><dtclass="param">certifications</dt><ddclass="cmt"><p>a group of certifications for the initial values</p></dd><dt>returns</dt><ddclass="cmt"><p><code>true</code>, if this is the first time and actual "initialization" is performed;
Although proper testing should be performed prior to attempting to remove the deployable to this toolbox,
a single test is administered to determine whether the removal can take place.</p><divclass="fullcomment"><divclass="comment cmt"><p>Stop managing the provided deployable.<br>
<br>
Although proper testing should be performed prior to attempting to remove the deployable to this toolbox,
a single test is administered to determine whether the removal can take place.
If the deployable is found to currently being managed by this toolbox, then it is properly removed.
No changes should occur if the deployable is not properly removed.</p></div><dlclass="paramcmts block"><dtclass="param">obj</dt><ddclass="cmt"><p>the deployable</p></dd><dt>returns</dt><ddclass="cmt"><p><code>true</code>, if the deployable is removed;
by testing if the specific deployable maximum and the deployable category maximum is non-zero</p><divclass="fullcomment"><divclass="comment cmt"><p>Determine if the given deployable can be managed by this toolbox
by testing if the specific deployable maximum and the deployable category maximum is non-zero</p></div><dlclass="paramcmts block"><dtclass="param">obj</dt><ddclass="cmt"><p>the deployable</p></dd><dt>returns</dt><ddclass="cmt"><p><code>true</code>, if both category maximum and deployable type maximum are positive non-zero integers;