Packages

class CaptureFlag extends Amenity

Represent a special entity that is carried by the player in certain circumstances. The entity is not a piece of Equipment so it does not go into the holsters, doe not into the player's inventory, and is not carried in or manipulated by the player's hands. The different game elements it simulates are: a facility's lattice logic unit (LLU), the cavern modules, and the rabbit ball (special game mode).

For the lattice logic unit, when a facility is set to generate an LLU upon hack, and an adjacent facility on the lattice provides an accommodating faction connection, the unit gets spawned at the LLU socket within the hacked facility. The LLU socket actually doesn't do anything but keep track of the spawned flag and provide a location. It associates with the faction of the hacker and, carried by other players of the same faction only, must be brought to the control console of a designated facility that is owned by the faction of the hacking empire. If the hack is cancelled through a resecure, the LLU despawns. If the facility is counter-hacked, the active LLU despawns and a new LLU is spawned in the socket. Other empires can not interact with the LLU while it is dropped on the ground and vehicles will be warned and then deconstructed if they linges too long near a dropped LLU. The LLU can not be submerged in water or it will despawn and the hack will cancel.

Source
CaptureFlag.scala
Linear Supertypes
Amenity, BlockMapEntity, StandardResistanceProfile, ResistanceProfile, Vitality, InGameHistory, PlanetSideServerObject, ZoneAware, FactionAffinity, PlanetSideGameObject, WorldEntity, IdentifiableEntity, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CaptureFlag
  2. Amenity
  3. BlockMapEntity
  4. StandardResistanceProfile
  5. ResistanceProfile
  6. Vitality
  7. InGameHistory
  8. PlanetSideServerObject
  9. ZoneAware
  10. FactionAffinity
  11. PlanetSideGameObject
  12. WorldEntity
  13. IdentifiableEntity
  14. Identifiable
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CaptureFlag(tDef: CaptureFlagDefinition)

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 Actor: ActorRef

    Retrieve a reference to the internal Actor.

    Retrieve a reference to the internal Actor.

    returns

    the internal ActorRef

    Definition Classes
    PlanetSideServerObject
  5. def Actor_=(control: ActorRef): ActorRef

    Assign an Actor to act for this server object.

    Assign an Actor to act for this server object. This reference is only set once, that is, as long as the internal ActorRef directs to ActorRef.noSender (null).

    control

    the Actor whose functionality will govern this server object

    returns

    the current internal ActorRef

    Definition Classes
    PlanetSideServerObject
  6. def CanDamage: Boolean
    Definition Classes
    Vitality
  7. def CanRepair: Boolean
    Definition Classes
    Vitality
  8. def Carrier: Option[Player]
  9. def Carrier_=(newCarrier: Option[Player]): Option[Player]
  10. def ClearHistory(): List[InGameActivity]
    Definition Classes
    InGameHistory
  11. def Continent: String
    Definition Classes
    ZoneAware
  12. def Continent_=(zoneId: String): String

    Give the entity a custom Zone identifier.

    Give the entity a custom Zone identifier.

    zoneId

    the custom identifier of the Zone object

    returns

    the identifier of the Zone object

    Definition Classes
    ZoneAware
  13. def DamageModel: DamageAndResistance
    Definition Classes
    Amenity → Vitality
  14. def DefaultHealth: Int
    Definition Classes
    Vitality
  15. def Definition: CaptureFlagDefinition
    Definition Classes
    CaptureFlag → Amenity → Vitality → PlanetSideGameObject
  16. def Destroyed: Boolean
    Definition Classes
    PlanetSideGameObject
  17. def Destroyed_=(state: Boolean): Boolean
    Definition Classes
    PlanetSideGameObject
  18. def Entity: WorldEntity
    Definition Classes
    PlanetSideGameObject
  19. def Entity_=(newEntity: WorldEntity): Unit
    Definition Classes
    PlanetSideGameObject
  20. def Faction: types.PlanetSideEmpire.Value

    Since a LLU belongs to a base, but needs to be picked up by the enemy faction, override the faction that owns the LLU to display the hacker faction.

    Since a LLU belongs to a base, but needs to be picked up by the enemy faction, override the faction that owns the LLU to display the hacker faction.

    Definition Classes
    CaptureFlag → Amenity → FactionAffinity
  21. def Faction_=(newFaction: types.PlanetSideEmpire.Value): types.PlanetSideEmpire.Value
    Definition Classes
    CaptureFlag → FactionAffinity
  22. def GUID: PlanetSideGUID
    Definition Classes
    IdentifiableEntity → Identifiable
  23. def GUID_=(guid: PlanetSideGUID): PlanetSideGUID
    Definition Classes
    IdentifiableEntity → Identifiable
  24. 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

  25. 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
  26. def Health: Int
    Definition Classes
    Vitality
  27. def Health_=(assignHealth: Int): Int
    Definition Classes
    Vitality
  28. def History: List[InGameActivity]
    Definition Classes
    InGameHistory
  29. 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
  30. def LastDamage: Option[DamageResult]
    Definition Classes
    InGameHistory
  31. def LastShot: Option[DamageResult]

    Find, specifically, the last instance of a weapon discharge that caused damage.

    Find, specifically, the last instance of a weapon discharge that caused damage.

    returns

    information about the discharge

    Definition Classes
    InGameHistory
  32. def LocationOffset: Vector3
    Definition Classes
    Amenity
  33. def LocationOffset_=(off: Option[Vector3]): Vector3
    Definition Classes
    Amenity
  34. def LocationOffset_=(off: Vector3): Vector3
    Definition Classes
    Amenity
  35. def LogActivity(result: DamageResult): List[InGameActivity]

    Very common example of a VitalsActivity event involving damage.

    Very common example of a VitalsActivity event involving damage. They are repackaged before submission and are often tagged for specific blame.

    result

    the fully-informed entry

    returns

    the list of previous changes to this object's vital statistics

    Definition Classes
    InGameHistory
  36. def LogActivity(action: Option[InGameActivity]): List[InGameActivity]

    An in-game event must be recorded.

    An in-game event must be recorded. Add new entry to the front of the list (for recent activity).

    action

    the fully-informed entry

    returns

    the list of previous changes to this entity

    Definition Classes
    InGameHistory
  37. def LogActivity(action: InGameActivity): List[InGameActivity]

    An in-game event must be recorded.

    An in-game event must be recorded. Add new entry to the front of the list (for recent activity).

    action

    the fully-informed entry

    returns

    the list of previous changes to this entity

    Definition Classes
    InGameHistory
  38. def MaxHealth: Int
    Definition Classes
    Vitality
  39. def MaxHealth_=(default: Option[Int]): Int
    Definition Classes
    Vitality
  40. def MaxHealth_=(default: Int): Int
    Definition Classes
    Vitality
  41. def Orientation: Vector3
    Definition Classes
    PlanetSideGameObject → WorldEntity
  42. def Orientation_=(vec: Vector3): Vector3
    Definition Classes
    PlanetSideGameObject → WorldEntity
  43. def Owner: AmenityOwner

    Reference the object that is in direct association with (is superior to) this one.

    Reference the object that is in direct association with (is superior to) this one.

    returns

    the object associated as this object's "owner"

    Definition Classes
    Amenity
  44. def Owner_=(obj: AmenityOwner): AmenityOwner

    Set an object to have a direct association with (be superior to) this one.

    Set an object to have a direct association with (be superior to) this one.

    obj

    the object trying to become associated as this object's "owner"

    returns

    the object associated as this object's "owner"

    Definition Classes
    Amenity
    See also

    Amenity.AmenityTarget

  45. def Position: Vector3

    When the flag is carried by a player, the position returned should be that of the carrier not the flag.

    When the flag is carried by a player, the position returned should be that of the carrier not the flag.

    returns

    the position of the carrier, if there is a player carrying the flag, or the flag itself

    Definition Classes
    CaptureFlag → PlanetSideGameObject → WorldEntity
  46. def Position_=(vec: Vector3): Vector3
    Definition Classes
    PlanetSideGameObject → WorldEntity
  47. def RadiationShielding: Float
    Definition Classes
    StandardResistanceProfile → ResistanceProfile
  48. def ResetControl(): ActorRef
    Definition Classes
    PlanetSideServerObject
  49. def Resist(dtype: vital.base.DamageType.Value): Float
    Definition Classes
    ResistanceProfile
  50. def ResistanceAggravated: Int
    Definition Classes
    StandardResistanceProfile → ResistanceProfile
  51. def ResistanceDirectHit: Int
    Definition Classes
    StandardResistanceProfile → ResistanceProfile
  52. def ResistanceSplash: Int
    Definition Classes
    StandardResistanceProfile → ResistanceProfile
  53. def Subtract: DamageProfile
    Definition Classes
    StandardResistanceProfile → ResistanceProfile
  54. def Target: Building
  55. def Target_=(newTarget: Building): Building
  56. def Velocity: Option[Vector3]
    Definition Classes
    PlanetSideGameObject → WorldEntity
  57. def Velocity_=(vec: Option[Vector3]): Option[Vector3]
    Definition Classes
    PlanetSideGameObject → WorldEntity
  58. def Velocity_=(vec: Vector3): Option[Vector3]
    Definition Classes
    WorldEntity
  59. def VitalsHistory(): List[VitalsActivity]

    Only the changes to vitality statistics.

    Only the changes to vitality statistics.

    returns

    a list of the chronologically-consistent vitality events

    Definition Classes
    InGameHistory
  60. def Zone: Zone
    Definition Classes
    Amenity → ZoneAware
  61. def Zone_=(zone: Zone): Zone

    When assigning a new Zone object for the Vehicle object, eliminate

    When assigning a new Zone object for the Vehicle object, eliminate

    zone

    a reference to the Zone object

    returns

    a reference to the Zone object

    Definition Classes
    ZoneAware
  62. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  63. 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
  64. 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
  65. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  66. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  67. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  68. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  69. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  70. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  71. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  72. 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
  73. 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
  74. 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
  75. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  76. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  77. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  78. 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
  79. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  80. def toString(): String
    Definition Classes
    AnyRef → Any
  81. 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
  82. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  83. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  84. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Amenity

Inherited from BlockMapEntity

Inherited from StandardResistanceProfile

Inherited from ResistanceProfile

Inherited from Vitality

Inherited from InGameHistory

Inherited from PlanetSideServerObject

Inherited from ZoneAware

Inherited from FactionAffinity

Inherited from PlanetSideGameObject

Inherited from WorldEntity

Inherited from IdentifiableEntity

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped