Class/Object

net.psforever.objects.avatar

DeployableToolbox

Related Docs: object DeployableToolbox | package avatar

Permalink

class DeployableToolbox extends AnyRef

A class that keeps track - "manages" - deployables that are owned by the avatar.

Deployables belong to the Engineering certification line of certifications. CombatEngineering and above certifications include permissions for different types of deployables, and one unique type of deployable is available through the GroundSupport and one that also requires AdvancedHacking. (They are collectively called "ce" for that reason.) Not only does the level of certification change the maximum number of deployables that can be managed by type but it also influences the maximum number of deployables that can be managed by category. Individual deployables are counted by type and category individually in special data structures to avoid having to probe the primary list of deployable references whenever a question of quantity is asked. As deployables are added and removed, and tracked certifications are added and removed, these structures are updated to reflect proper count.

Source
DeployableToolbox.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DeployableToolbox
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DeployableToolbox()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from DeployableToolbox to any2stringadd[DeployableToolbox] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DeployableToolbox, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from DeployableToolbox to ArrowAssoc[DeployableToolbox] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def Accept(obj: AcceptableDeployable): Boolean

    Permalink

    Determine if the given deployable can be managed by this toolbox.

    Determine if the given deployable can be managed by this toolbox.

    obj

    the deployable

    returns

    true, if it can be managed under the current conditions; false, otherwise

    See also

    Contains

    Available

    Valid

  7. def Add(obj: AcceptableDeployable): Boolean

    Permalink

    Manage the provided deployable.

    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.

    Manage the provided deployable.

    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.

    obj

    the deployable

    returns

    true, if the deployable is added; false, otherwise

  8. def AddToDeployableQuantities(certification: types.CertificationType.Value, certificationSet: Set[types.CertificationType.Value]): Unit

    Permalink

    Change the count of deployable units that can be tracked by providing a new certification.

    Change the count of deployable units that can be tracked by providing a new certification. If the given certification is already factored into the quantities, no changes will occur.

    certification

    the new certification

    certificationSet

    the group of previous certifications being tracked; occasionally, important former certification values are required for additional configuration; the new certification should already have been added to this group

  9. def Available(obj: AcceptableDeployable): Boolean

    Permalink

    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.

    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.

    obj

    the deployable

    returns

    true, if the deployable can be added to the support lists and counted; false, otherwise

  10. def Category(filter: ce.DeployableCategory.Value): List[PlanetSideGUID]

    Permalink

    Reference all managed deployables in the same category.

    Reference all managed deployables in the same category.

    filter

    the type of deployable

    returns

    a list of globally unique identifiers that should be valid for the current zone

  11. def Category(filter: AcceptableDeployable): List[PlanetSideGUID]

    Permalink

    Reference all managed deployables in the same category as an example deployable.

    Reference all managed deployables in the same category as an example deployable.

    filter

    the example deployable

    returns

    a list of globally unique identifiers that should be valid for the current zone

  12. def Clear(): List[PlanetSideGUID]

    Permalink

    Remove all managed deployables.

    Remove all managed deployables.

    returns

    a list of globally unique identifiers that should be valid for the current zone

  13. def ClearCategory(item: ce.DeployedItem.Value): List[PlanetSideGUID]

    Permalink

    Remove all managed deployables that belong to the same category.

    Remove all managed deployables that belong to the same category.

    item

    the deployable type belonging to a category

    returns

    a list of globally unique identifiers that should be valid for the current zone

  14. def ClearDeployable(item: ce.DeployedItem.Value): List[PlanetSideGUID]

    Permalink

    Remove all managed deployables that are the same type.

    Remove all managed deployables that are the same type.

    item

    the deployable type

    returns

    a list of globally unique identifiers that should be valid for the current zone

  15. def Contains(obj: AcceptableDeployable): Boolean

    Permalink

    Check if this deployable is already being managed by the toolbox by determining whether or not it is already being managed by this toolbox.

    Check if this deployable is already being managed by the toolbox by determining whether or not it is already being managed by this toolbox.

    obj

    the deployable

    returns

    true, if the deployable can be found in one of the lists; false, otherwise

  16. def CountCategory(item: ce.DeployedItem.Value): (Int, Int)

    Permalink

    Check the current capacity for the same category of deployable as the example.

    Check the current capacity for the same category of deployable as the example.

    item

    the example deployable

    returns

    the current quantity of deployables and the maximum number

  17. def CountDeployable(item: ce.DeployedItem.Value): (Int, Int)

    Permalink

    Check the current capacity for the same type of deployable as the example.

    Check the current capacity for the same type of deployable as the example.

    item

    the example deployable

    returns

    the current quantity of deployables and the maximum number

  18. def Deployables(filter: ce.DeployedItem.Value): List[PlanetSideGUID]

    Permalink

    Reference all managed deployables of the same type.

    Reference all managed deployables of the same type.

    filter

    the type of deployable

    returns

    a list of globally unique identifiers that should be valid for the current zone

  19. def Deployables(filter: AcceptableDeployable): List[PlanetSideGUID]

    Permalink

    Reference all managed deployables of the same type as an example deployable.

    Reference all managed deployables of the same type as an example deployable.

    filter

    the example deployable

    returns

    a list of globally unique identifiers that should be valid for the current zone

  20. def DisplaceFirst(category: ce.DeployableCategory.Value): Option[AcceptableDeployable]

    Permalink

    Remove the first managed deployable from a category.

    Remove the first managed deployable from a category. The only test performed is whether there is any valid deployable managed for the category.

    category

    the target category

    returns

    any deployable that is found

  21. def DisplaceFirst(obj: AcceptableDeployable, rule: (Deployable) ⇒ Boolean): Option[AcceptableDeployable]

    Permalink

    Remove the first managed deployable that satisfies a test and belongs to the same category as the example.

    Remove the first managed deployable that satisfies a test and belongs to the same category as the example. The test in question is used to pinpoint the first qualifying deployable; but, if the test fails to find any valid targets, the first deployable in the list of managed deployables for that category is selected to be removed. The only test performed is whether there is any valid deployable managed for the category.

    obj

    the example deployable

    rule

    the testing rule for determining a valid deployable

    returns

    any deployable that is found

  22. def DisplaceFirst(obj: AcceptableDeployable): Option[AcceptableDeployable]

    Permalink

    Remove the first managed deployable that matches the same type of deployable as the example.

    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.

    obj

    the example deployable

    returns

    any deployable that is found

  23. def Initialize(certifications: Set[types.CertificationType.Value]): Boolean

    Permalink

    Set up the initial deployable counts by providing certification values to be used in category and unit selection.

    Set up the initial deployable counts by providing certification values to be used in category and unit selection.

    certifications

    a group of certifications for the initial values

    returns

    true, if this is the first time and actual "initialization" is performed; false, otherwise

  24. def Remove(obj: AcceptableDeployable): Boolean

    Permalink

    Stop managing the provided deployable.

    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.

    Stop managing the provided deployable.

    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.

    obj

    the deployable

    returns

    true, if the deployable is added; false, otherwise

  25. def RemoveFromDeployableQuantities(certification: types.CertificationType.Value, certificationSet: Set[types.CertificationType.Value]): Unit

    Permalink

    Change the count of deployable units that can be tracked by designating a certification whose deployables will be removed.

    Change the count of deployable units that can be tracked by designating a certification whose deployables will be removed. If the given certification is already factored out of the quantities, no changes will occur.

    certification

    the old certification

    certificationSet

    the group of previous certifications being tracked; occasionally, important former certification values are required for additional configuration; the new certification should already have been excluded from this group

  26. def UpdateUI(certifications: List[types.CertificationType.Value]): List[(Int, Int, Int, Int)]

    Permalink
  27. def UpdateUI(entry: types.CertificationType.Value): List[(Int, Int, Int, Int)]

    Permalink
  28. def UpdateUI(): List[(Int, Int, Int, Int)]

    Permalink
  29. def UpdateUIElement(entry: ce.DeployedItem.Value): List[(Int, Int, Int, Int)]

    Permalink
  30. def Valid(obj: AcceptableDeployable): Boolean

    Permalink

    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

    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

    obj

    the deployable

    returns

    true, if both category maximum and deployable type maximum are positive non-zero integers; false, otherwise

  31. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  32. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. def ensuring(cond: (DeployableToolbox) ⇒ Boolean, msg: ⇒ Any): DeployableToolbox

    Permalink
    Implicit information
    This member is added by an implicit conversion from DeployableToolbox to Ensuring[DeployableToolbox] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  34. def ensuring(cond: (DeployableToolbox) ⇒ Boolean): DeployableToolbox

    Permalink
    Implicit information
    This member is added by an implicit conversion from DeployableToolbox to Ensuring[DeployableToolbox] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  35. def ensuring(cond: Boolean, msg: ⇒ Any): DeployableToolbox

    Permalink
    Implicit information
    This member is added by an implicit conversion from DeployableToolbox to Ensuring[DeployableToolbox] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  36. def ensuring(cond: Boolean): DeployableToolbox

    Permalink
    Implicit information
    This member is added by an implicit conversion from DeployableToolbox to Ensuring[DeployableToolbox] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  37. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  38. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  39. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  40. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from DeployableToolbox to StringFormat[DeployableToolbox] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  41. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  42. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  43. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  44. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  45. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  46. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  47. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  48. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  49. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  52. def [B](y: B): (DeployableToolbox, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from DeployableToolbox to ArrowAssoc[DeployableToolbox] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from DeployableToolbox to any2stringadd[DeployableToolbox]

Inherited by implicit conversion StringFormat from DeployableToolbox to StringFormat[DeployableToolbox]

Inherited by implicit conversion Ensuring from DeployableToolbox to Ensuring[DeployableToolbox]

Inherited by implicit conversion ArrowAssoc from DeployableToolbox to ArrowAssoc[DeployableToolbox]

Ungrouped