Packages

class ConstructionItem extends Equipment with FireModeSwitch[ConstructionFireMode]

A type of Equipment that can be wielded and applied to the game world to produce other game objects.

Functionally, ConstructionItem objects resemble Tool objects that have fire mode state and alternate "ammunition." Very much unlike Tool object counterparts, however, the alternate "ammunition" is also a type of fire mode state maintained in a two-dimensional grid of related states. These states represent output products called deployables or, in the common vernacular, CE. Also unlike Tool objects, whose ammunition is always available even when drawing the weapon is not permitted, the different states are not all available if just the equipment itself is available. Parameters along with these CE states indicate whether the current output product is something the player is permitted to utilize.

Source
ConstructionItem.scala
Linear Supertypes
FireModeSwitch[ConstructionFireMode], Equipment, BlockMapEntity, FactionAffinity, PlanetSideGameObject, WorldEntity, IdentifiableEntity, Identifiable, AnyRef, Any
Known Subclasses
Telepad
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConstructionItem
  2. FireModeSwitch
  3. Equipment
  4. BlockMapEntity
  5. FactionAffinity
  6. PlanetSideGameObject
  7. WorldEntity
  8. IdentifiableEntity
  9. Identifiable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ConstructionItem(cItemDef: ConstructionItemDefinition)

    cItemDef

    the ObjectDefinition that constructs this item and maintains some of its immutable fields

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def AmmoType: ce.DeployedItem.Value
  5. def AmmoTypeIndex: Int
  6. def AmmoTypeIndex_=(index: Int): Int
  7. def Definition: ConstructionItemDefinition
    Definition Classes
    ConstructionItem → Equipment → PlanetSideGameObject
  8. def Destroyed: Boolean
    Definition Classes
    PlanetSideGameObject
  9. def Destroyed_=(state: Boolean): Boolean
    Definition Classes
    PlanetSideGameObject
  10. def Entity: WorldEntity
    Definition Classes
    PlanetSideGameObject
  11. def Entity_=(newEntity: WorldEntity): Unit
    Definition Classes
    PlanetSideGameObject
  12. def Faction: types.PlanetSideEmpire.Value
    Definition Classes
    Equipment → FactionAffinity
  13. def Faction_=(fact: types.PlanetSideEmpire.Value): types.PlanetSideEmpire.Value
    Definition Classes
    Equipment → FactionAffinity
  14. def FireMode: ConstructionFireMode
    Definition Classes
    ConstructionItem → FireModeSwitch
  15. def FireModeIndex: Int
    Definition Classes
    ConstructionItem → FireModeSwitch
  16. def FireModeIndex_=(index: Int): Int
    Definition Classes
    ConstructionItem → FireModeSwitch
  17. def GUID: PlanetSideGUID
    Definition Classes
    IdentifiableEntity → Identifiable
  18. def GUID_=(guid: PlanetSideGUID): PlanetSideGUID
    Definition Classes
    IdentifiableEntity → Identifiable
  19. def GUID_=(guid: StalePlanetSideGUID): PlanetSideGUID

    Always intercept StalePlanetSideGUID references when attempting to mutate the GUID value.

    Always intercept StalePlanetSideGUID references when attempting to mutate the GUID value.

    guid

    the valid GUID to assign

    returns

    never returns

    Definition Classes
    IdentifiableEntity
    Exceptions thrown

    `AssigningGUIDException` always

  20. def HasGUID: Boolean

    Flag when the object has no GUID (initial condition) or is considered stale.

    Flag when the object has no GUID (initial condition) or is considered stale.

    returns

    whether the value of the GUID is a valid representation for this object

    Definition Classes
    IdentifiableEntity
  21. def Invalidate(): Unit

    Indicate that the current GUID is no longer a valid representation of the object.

    Indicate that the current GUID is no longer a valid representation of the object. Transforms whatever the current GUID is into a StalePlanetSideGUID entity with the same value. Doing this restores the object to its default mutation option ("the ability to set a new valid GUID"). The current GUID will still be accessed as if it were valid, but it will be wrapped in the new stale object.

    Definition Classes
    IdentifiableEntity
  22. def ModePermissions: Set[Certification]
  23. def NextAmmoType: ce.DeployedItem.Value
  24. def NextFireMode: ConstructionFireMode
    Definition Classes
    ConstructionItem → FireModeSwitch
  25. def Orientation: Vector3
    Definition Classes
    PlanetSideGameObject → WorldEntity
  26. def Orientation_=(vec: Vector3): Vector3
    Definition Classes
    PlanetSideGameObject → WorldEntity
  27. def Position: Vector3
    Definition Classes
    PlanetSideGameObject → WorldEntity
  28. def Position_=(vec: Vector3): Vector3
    Definition Classes
    PlanetSideGameObject → WorldEntity
  29. def Size: equipment.EquipmentSize.Value
    Definition Classes
    Equipment
  30. def Tile: InventoryTile
    Definition Classes
    Equipment
  31. def Velocity: Option[Vector3]
    Definition Classes
    PlanetSideGameObject → WorldEntity
  32. def Velocity_=(vec: Option[Vector3]): Option[Vector3]
    Definition Classes
    PlanetSideGameObject → WorldEntity
  33. def Velocity_=(vec: Vector3): Option[Vector3]
    Definition Classes
    WorldEntity
  34. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  35. def blockMapEntry: Option[BlockMapEntry]

    internal data regarding an active representation on a blockmap

    internal data regarding an active representation on a blockmap

    Definition Classes
    BlockMapEntity
  36. def blockMapEntry_=(entry: Option[BlockMapEntry]): Option[BlockMapEntry]

    internal data regarding an active representation on a blockmap

    internal data regarding an active representation on a blockmap

    Definition Classes
    BlockMapEntity
  37. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  38. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  40. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  41. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  42. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. def isMoving(test: Float): Boolean

    This object is not considered moving unless it is moving at least as fast as a certain velocity.

    This object is not considered moving unless it is moving at least as fast as a certain velocity.

    test

    the (squared) velocity to test against

    returns

    true, if we are moving; false, otherwise

    Definition Classes
    WorldEntity
  45. def isMoving(test: Vector3): Boolean

    This object is not considered moving unless it is moving at least as fast as a certain velocity.

    This object is not considered moving unless it is moving at least as fast as a certain velocity.

    test

    the velocity to test against

    returns

    true, if we are moving; false, otherwise

    Definition Classes
    WorldEntity
  46. def isMoving: Boolean

    A velocity of non-zero is the same as moving.

    A velocity of non-zero is the same as moving.

    returns

    true, if we are moving; false, otherwise

    Definition Classes
    WorldEntity
  47. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  49. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  50. def resetAmmoTypes(): Unit
  51. def sector(zone: Zone, range: Float): SectorPopulation

    Buckets in the blockmap are called "sectors".

    Buckets in the blockmap are called "sectors". Find the sectors in a given blockmap in which the entity would be represented within a given range.

    zone

    what region the blockmap represents

    range

    the custom distance from the central sector along the major axes

    returns

    a conglomerate sector which lists all of the entities in the allocated sector(s)

    Definition Classes
    BlockMapEntity
  52. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  53. def toString(): String
    Definition Classes
    Equipment → AnyRef → Any
  54. def updateBlockMapEntry(newCoords: Vector3): Boolean

    Update the internal data's known coordinate position without changing representation on whatever blockmap.

    Update the internal data's known coordinate position without changing representation on whatever blockmap. Has the potential to cause major issues with the blockmap if used without external checks.

    newCoords

    the coordinate position

    returns

    true, if the coordinates were updated; false, otherwise

    Definition Classes
    BlockMapEntity
  55. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from FireModeSwitch[ConstructionFireMode]

Inherited from Equipment

Inherited from BlockMapEntity

Inherited from FactionAffinity

Inherited from PlanetSideGameObject

Inherited from WorldEntity

Inherited from IdentifiableEntity

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped