Class/Object

net.psforever.objects

LockerContainer

Related Docs: object LockerContainer | package objects

Permalink

class LockerContainer extends Equipment with Container

The companion of a Locker that is carried with a player masquerading as their sixth EquipmentSlot object and a sub-inventory item. The Player class refers to it as the "fifth slot" as its permanent slot number is encoded as 0x85. The inventory of this object is accessed using a game world Locker object (mb_locker).

Source
LockerContainer.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LockerContainer
  2. Container
  3. Equipment
  4. FactionAffinity
  5. PlanetSideGameObject
  6. WorldEntity
  7. IdentifiableEntity
  8. Identifiable
  9. AnyRef
  10. 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 LockerContainer()

    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 LockerContainer to any2stringadd[LockerContainer] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (LockerContainer, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from LockerContainer to ArrowAssoc[LockerContainer] 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 Collisions(index: Int, width: Int, height: Int): Try[List[InventoryItem]]

    Permalink

    Given a region of "searchable unit positions" considered as stowable, determine if any previously stowed items are contained within that region.

    Default usage, and recommended the continued inclusion of that use, is defined in terms of Equipment being stowed in a GridInventory.

    Given a region of "searchable unit positions" considered as stowable, determine if any previously stowed items are contained within that region.

    Default usage, and recommended the continued inclusion of that use, is defined in terms of Equipment being stowed in a GridInventory. Where the Equipment object is defined by the dimensions width and height, starting a search at index will search all positions within a grid-like range of numbers. Under certain searching conditions, this range may be meaningless, such as is the case when searching individual positions that are normal EquipmentSlot objects. Regardless, the value collected indicates the potential of multiple objects being discovered and maintains a reference to the object itself and the slot position where the object is located. (As any object can be discovered within the range, that is important.)

    index

    the position to start searching

    width

    the width of the searchable space

    height

    the height of the serachable space

    returns

    a list of objects that have been encountered within the searchable space

    Definition Classes
    Container
    See also

    GridInventory.CheckCollisionsVar

  7. def Definition: EquipmentDefinition

    Permalink
  8. def Entity: WorldEntity

    Permalink
    Definition Classes
    PlanetSideGameObject
  9. def Entity_=(newEntity: WorldEntity): Unit

    Permalink
    Definition Classes
    PlanetSideGameObject
  10. def Faction: types.PlanetSideEmpire.Value

    Permalink
    Definition Classes
    EquipmentFactionAffinity
  11. def Faction_=(fact: types.PlanetSideEmpire.Value): types.PlanetSideEmpire.Value

    Permalink
    Definition Classes
    EquipmentFactionAffinity
  12. def Find(guid: PlanetSideGUID): Option[Int]

    Permalink

    Given globally unique identifier, if the object using it is stowed, attempt to locate its slot.

    Given globally unique identifier, if the object using it is stowed, attempt to locate its slot. All positions, VisibleSlot and Inventory, and wherever else, should be searchable.

    guid

    the GUID of the Equipment

    returns

    the index of the EquipmentSlot, or None

    Definition Classes
    Container
  13. def Find(obj: Equipment): Option[Int]

    Permalink

    Given an object, attempt to locate its slot.

    Given an object, attempt to locate its slot. All positions, VisibleSlot and Inventory, and wherever else, should be searchable.

    obj

    the Equipment object

    returns

    the index of the EquipmentSlot, or None

    Definition Classes
    Container
  14. def Fit(tile: InventoryTile): Option[Int]

    Permalink
    Definition Classes
    Container
  15. def Fit(obj: Equipment): Option[Int]

    Permalink
    Definition Classes
    Container
  16. def GUID: PlanetSideGUID

    Permalink
    Definition Classes
    IdentifiableEntityIdentifiable
  17. def GUID_=(guid: PlanetSideGUID): PlanetSideGUID

    Permalink
    Definition Classes
    IdentifiableEntityIdentifiable
  18. def HasGUID: Boolean

    Permalink
    Definition Classes
    IdentifiableEntity
  19. def Invalidate(): Unit

    Permalink
    Definition Classes
    IdentifiableEntity
  20. def Inventory: GridInventory

    Permalink

    A(n imperfect) reference to a generalized pool of the contained objects.

    A(n imperfect) reference to a generalized pool of the contained objects. Having access to all of the available positions is not required. The entries in this reference should definitely include all unseen positions. The GridInventory returned by this accessor is also an implementation of Container.

    Definition Classes
    LockerContainerContainer
    See also

    VisibleSlots

  21. def Orientation: Vector3

    Permalink
    Definition Classes
    PlanetSideGameObjectWorldEntity
  22. def Orientation_=(vec: Vector3): Vector3

    Permalink
    Definition Classes
    PlanetSideGameObjectWorldEntity
  23. def Position: Vector3

    Permalink
    Definition Classes
    PlanetSideGameObjectWorldEntity
  24. def Position_=(vec: Vector3): Vector3

    Permalink
    Definition Classes
    PlanetSideGameObjectWorldEntity
  25. def Size: equipment.EquipmentSize.Value

    Permalink
    Definition Classes
    Equipment
  26. def Slot(slotNum: Int): EquipmentSlot

    Permalink

    Access to all stowable positions on this object by index.

    All positions, VisibleSlot and Inventory, and wherever else, should be reachable.

    Access to all stowable positions on this object by index.

    All positions, VisibleSlot and Inventory, and wherever else, should be reachable. Regardless of the internal storage medium, the format of return is expected to be the same structure of object as the most basic storage component for Equipment, namely, EquipmentSlot objects. By default, it is expected to return an EquipmentSlot that can not be manipulated because it is Blocked.

    slotNum

    an index

    returns

    the searchable position identified by that index

    Definition Classes
    Container
    See also

    OffhandEquipmentSlot

  27. def Tile: InventoryTile

    Permalink
    Definition Classes
    Equipment
  28. def Velocity: Option[Vector3]

    Permalink
    Definition Classes
    PlanetSideGameObjectWorldEntity
  29. def Velocity_=(vec: Option[Vector3]): Option[Vector3]

    Permalink
    Definition Classes
    PlanetSideGameObjectWorldEntity
  30. def Velocity_=(vec: Vector3): Option[Vector3]

    Permalink
    Definition Classes
    WorldEntity
  31. def VisibleSlots: Set[Int]

    Permalink

    A(n imperfect) reference to a generalized pool of the contained objects.

    Having access to all of the available positions is not required.

    A(n imperfect) reference to a generalized pool of the contained objects.

    Having access to all of the available positions is not required. Only the positions that can be actively viewed by other clients are listed.

    returns

    all of the affected slot indices

    Definition Classes
    LockerContainerContainer
    See also

    Inventory

  32. final def asInstanceOf[T0]: T0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Inherited from Container

Inherited from Equipment

Inherited from FactionAffinity

Inherited from PlanetSideGameObject

Inherited from WorldEntity

Inherited from IdentifiableEntity

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped