Class/Object

net.psforever.objects.serverobject.terminals

ProximityTerminal

Related Docs: object ProximityTerminal | package terminals

Permalink

class ProximityTerminal extends Terminal with ProximityUnit

A server object that is a "terminal" that can be accessed for amenities and services, triggered when a certain distance from the unit itself (proximity-based).

Unlike conventional terminals, this structure is not necessarily structure-owned. For example, the cavern crystals are considered owner-neutral elements that are not attached to a Building object.

Source
ProximityTerminal.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProximityTerminal
  2. ProximityUnit
  3. Terminal
  4. Hackable
  5. Amenity
  6. PlanetSideServerObject
  7. ZoneAware
  8. FactionAffinity
  9. PlanetSideGameObject
  10. WorldEntity
  11. IdentifiableEntity
  12. Identifiable
  13. AnyRef
  14. 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 ProximityTerminal(tdef: ProximityTerminalDefinition)

    Permalink

    tdef

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from ProximityTerminal to ArrowAssoc[ProximityTerminal] 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 Actor: ActorRef

    Permalink

    Retrieve a reference to the internal Actor.

    Retrieve a reference to the internal Actor.

    returns

    the internal ActorRef

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

    Permalink

    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 Actor.noSender (null).

    control

    the Actor whose functionality will govern this server object

    returns

    the current internal ActorRef

    Definition Classes
    PlanetSideServerObject
  8. def AddUser(target: PlanetSideGameObject): Boolean

    Permalink

    Accept a new target for this unit.

    Accept a new target for this unit.

    target

    the new target

    returns

    true, if the entrant has been added and is new to the list; false if the entrant is already in the list or can not be added

    Definition Classes
    ProximityUnit
  9. def Continent: String

    Permalink
    Definition Classes
    AmenityPlanetSideServerObjectZoneAware
  10. def Continent_=(zone: String): String

    Permalink
    Definition Classes
    PlanetSideServerObjectZoneAware
  11. def Damaged(dam: Int): Unit

    Permalink
    Definition Classes
    Terminal
  12. def Definition: TerminalDefinition

    Permalink
    Definition Classes
    TerminalPlanetSideGameObject
  13. def Entity: WorldEntity

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

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

    Permalink
    Definition Classes
    AmenityFactionAffinity
  16. def Faction_=(fac: types.PlanetSideEmpire.Value): types.PlanetSideEmpire.Value

    Permalink
    Definition Classes
    FactionAffinity
  17. def GUID: PlanetSideGUID

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

    Permalink
    Definition Classes
    IdentifiableEntityIdentifiable
  19. def HackDuration: Array[Int]

    Permalink
    Definition Classes
    Hackable
  20. def HackDuration_=(arr: Array[Int]): Array[Int]

    Permalink
    Definition Classes
    Hackable
  21. def HackEffectDuration: Array[Int]

    Permalink
    Definition Classes
    Hackable
  22. def HackEffectDuration_=(arr: Array[Int]): Array[Int]

    Permalink
    Definition Classes
    Hackable
  23. def HackSound: packet.game.TriggeredSound.Value

    Permalink
    Definition Classes
    Hackable
  24. def HackSound_=(sound: packet.game.TriggeredSound.Value): packet.game.TriggeredSound.Value

    Permalink
    Definition Classes
    Hackable
  25. def HackedBy: Option[HackInfo]

    Permalink
    Definition Classes
    Hackable
  26. def HackedBy_=(hackInfo: HackInfo): Option[HackInfo]

    Permalink
    Definition Classes
    Hackable
  27. def HackedBy_=(agent: Option[Player]): Option[HackInfo]

    Permalink

    Set the hack state of this object by recording important information about the player who caused it.

    Set the hack state of this object by recording important information about the player who caused it. Set the hack state if there is no current hack state. Override the hack state with a new hack state if the new user has different faction affiliation.

    agent

    a Player, or no player

    returns

    the player hack entry

    Definition Classes
    Hackable
  28. def HackedBy_=(agent: Player): Option[HackInfo]

    Permalink
    Definition Classes
    Hackable
  29. def HasGUID: Boolean

    Permalink
    Definition Classes
    IdentifiableEntity
  30. def Health: Int

    Permalink
    Definition Classes
    Terminal
  31. def Invalidate(): Unit

    Permalink
    Definition Classes
    IdentifiableEntity
  32. def LocationOffset: Vector3

    Permalink
    Definition Classes
    Amenity
  33. def LocationOffset_=(off: Option[Vector3]): Vector3

    Permalink
    Definition Classes
    Amenity
  34. def LocationOffset_=(off: Vector3): Vector3

    Permalink
    Definition Classes
    Amenity
  35. def NumberUsers: Int

    Permalink
    Definition Classes
    ProximityUnit
  36. def Orientation: Vector3

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

    Permalink
    Definition Classes
    PlanetSideGameObjectWorldEntity
  38. def Owner: PlanetSideServerObject

    Permalink

    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
  39. def Owner_=[T](obj: T)(implicit arg0: AmenityTarget[T]): PlanetSideServerObject

    Permalink

    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.

    T

    a validation of the type of object that can be an owner

    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

  40. def Position: Vector3

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

    Permalink
    Definition Classes
    PlanetSideGameObjectWorldEntity
  42. def RemoveUser(target: PlanetSideGameObject): Boolean

    Permalink

    Remove an existing target for this unit.

    Remove an existing target for this unit.

    target

    the target

    returns

    true, if the submitted entity was previously in the list but is not longer in the list; false, if the submitted entity was never in the list or can not be removed

    Definition Classes
    ProximityUnit
  43. def Repair(rep: Int): Unit

    Permalink
    Definition Classes
    Terminal
  44. def Request(player: Player, msg: Any): Exchange

    Permalink

    Process a message (a "request") dispatched by the user.

    Process a message (a "request") dispatched by the user. To be accessible, the terminal must be owned by the same faction by the user or must be compromised.

    player

    the player

    msg

    the original packet carrying the request

    returns

    an actionable message that explains what resulted from interacting with this Terminal

    Definition Classes
    ProximityTerminalTerminal
    See also

    PlanetSideEmpire

    FactionAffinity

  45. def Targets: Seq[PlanetSideGameObject]

    Permalink
    Definition Classes
    ProximityUnit
  46. def Validate(radius: Float, validations: Seq[(PlanetSideGameObject) ⇒ Boolean])(target: PlanetSideGameObject): Boolean

    Permalink

    Confirm whether the entity is a valid target for the effects of this unit.

    Confirm whether the entity is a valid target for the effects of this unit. Curried to accept parameters for the tests separately from the entity to be tested. In general, the two requirements beyond the custom validations involve distance (from the unit) and inclusiveness (known to the unit beforehand).

    radius

    the squared minimum activation distance

    validations

    the custom tests that the entity must pass to be considered valid; in general, regardless of the type of the target, any of the tests must be passed

    target

    the submitted entity

    returns

    true, if the entity passes the validation tests; false, otherwise

    Definition Classes
    ProximityUnit
  47. def Validate(target: PlanetSideGameObject): Boolean

    Permalink

    Confirm whether the entity is a valid target for the effects of this unit.

    Confirm whether the entity is a valid target for the effects of this unit.

    target

    the submitted entity

    returns

    true, if the entity passes the validation tests; false, otherwise

    Definition Classes
    ProximityUnit
  48. def Velocity: Option[Vector3]

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

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

    Permalink
    Definition Classes
    WorldEntity
  51. final def asInstanceOf[T0]: T0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Inherited from ProximityUnit

Inherited from Terminal

Inherited from Hackable

Inherited from Amenity

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

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

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

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

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

Ungrouped