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 InitSquadDetail(guid: PlanetSideGUID, to: Iterable[Long], squad: Squad): Unit

   Dispatch an intial message entailing the strategic information and the composition of this squad.

   Dispatch an intial message entailing the strategic information and the composition of this squad. The details of the squad will be updated in full and be sent to all indicated observers.

   guid

   the unique squad identifier to be used when composing the details for this message

   to

   the unique character identifier numbers of the players who will receive this message

   squad

   the squad from which the squad details shall be composed

   See also

   SquadService.PublishFullDetails

5.  def InitSquadDetail(features: SquadFeatures): Unit

   Dispatch a message entailing the composition of this squad.

   Dispatch a message entailing the composition of this squad. This is considered the first time this information will be dispatched to any relevant observers so the details of the squad will be updated in full and be sent to all relevant observers, namely, all the occupants of the squad. External observers are ignored.

   features

   the squad

   See also

   InitSquadDetail(PlanetSideGUID, Iterable[Long], Squad)

6.  val MonitorSquadDetails: LongMap[MonitorEntry]

   Players who are interested in updated details regarding a certain squad though they may not be a member of the squad.
   key - unique character identifier number; value - a squad identifier number

7.  def Publish[ANY >: Any](to: ANY, msg: Response, excluded: Iterable[Long]): Unit

   Overloaded message-sending operation.

   Overloaded message-sending operation. No message can be sent using this distinction. Log a warning.

   to

   something that was expected to be used as the channel for the message but is not handled as such

   msg

   a message that can be stored in a SquadServiceResponse object

   excluded

   a group of character identifier numbers who should not receive the message

8.  def Publish[ANY >: Any](to: ANY, msg: Response): Unit

   Overloaded message-sending operation.

   Overloaded message-sending operation. No message can be sent using this distinction. Log a warning.

   to

   something that was expected to be used as the channel for the message but is not handled as such

   msg

   a message that can be stored in a SquadServiceResponse object

9.  def Publish(to: Long, msg: Response, excluded: Iterable[Long]): Unit

   Overloaded message-sending operation.

   Overloaded message-sending operation. Always publishes on the ActorRef objects retained by the UserEvents object.

   to

   a unique character identifier used as the channel for the message

   msg

   a message that can be stored in a SquadServiceResponse object

   excluded

   a group of character identifier numbers who should not receive the message

10.  def Publish(to: Long, msg: Response): Unit

    Overloaded message-sending operation.

    Overloaded message-sending operation. Always publishes on the ActorRef objects retained by the UserEvents object.

    to

    a unique character identifier used as the channel for the message

    msg

    a message that can be stored in a SquadServiceResponse object

11.  def Publish(to: String, msg: Response, excluded: Iterable[Long]): Unit

    Overloaded message-sending operation.

    Overloaded message-sending operation. Strings come in three accepted patterns. The first resolves into a faction name, as determined by PlanetSideEmpire when transformed into a string. The second resolves into a squad's dedicated channel, a name that is formulaic. The third resolves as a unique character identifier number.

    to

    a string used as the channel for the message

    msg

    a message that can be stored in a SquadServiceResponse object

    excluded

    a group of character identifier numbers who should not receive the message (resolved at destination, usually)

12.  def Publish(to: String, msg: Response): Unit

    Overloaded message-sending operation.

    Overloaded message-sending operation. Strings come in three accepted patterns. The first resolves into a faction name, as determined by PlanetSideEmpire when transformed into a string. The second resolves into a squad's dedicated channel, a name that is formulaic. The third resolves as a unique character identifier number.

    to

    a string used as the channel for the message

    msg

    a message that can be stored in a SquadServiceResponse object

13.  def Publish(to: Type, msg: Response, excluded: Iterable[Long]): Unit

    Overloaded message-sending operation.

    Overloaded message-sending operation. Always publishes on the SquadEvents object.

    to

    a faction affiliation used as the channel for the message

    msg

    a message that can be stored in a SquadServiceResponse object

    excluded

    a group of character identifier numbers who should not receive the message (resolved at destination)

14.  def Publish(to: Type, msg: Response): Unit

    Overloaded message-sending operation.

    Overloaded message-sending operation. Always publishes on the SquadEvents object.

    to

    a faction affiliation used as the channel for the message

    msg

    a message that can be stored in a SquadServiceResponse object

15.  def Publish(to: ActorRef, msg: Response, excluded: Iterable[Long]): Unit

    Overloaded message-sending operation.

    Overloaded message-sending operation. The Actor version wraps around the expected ! functionality.

    to

    an ActorRef which to send the message

    msg

    a message that can be stored in a SquadServiceResponse object

    excluded

    a group of character identifier numbers who should not receive the message (resolved at destination)

16.  def Publish(to: ActorRef, msg: Response): Unit

    Overloaded message-sending operation.

    Overloaded message-sending operation. The Actor version wraps around the expected ! functionality.

    to

    an ActorRef which to send the message

    msg

    a message that can be stored in a SquadServiceResponse object

17.  def PublishToMonitorTargets(guid: PlanetSideGUID, excluding: Iterable[Long]): Iterable[Long]

    na

    na

    guid

    the unique squad identifier number to be used for the squad detail message

    excluding

    the explicit unique character identifier numbers of individuals who should not receive the message

    See also

    LongMap.subtractOne

    SquadSubscriptionEntity.MonitorEntry

18.  val SquadEvents: GenericEventBus[SquadServiceResponse]

    This is a formal ActorEventBus object that is reserved for faction-wide messages and squad-specific messages.

    This is a formal ActorEventBus object that is reserved for faction-wide messages and squad-specific messages. When the user joins the SquadService with a Service.Join message that includes a confirmed faction affiliation identifier, the origin ActorRef is added as a subscription. Squad channels are produced when a squad is created, and are subscribed to as users join the squad, and unsubscribed from as users leave the squad.
    key - a PlanetSideEmpire value; value - ActorRef reference
    key - a consistent squad channel name; value - ActorRef reference

    See also

    CloseSquad

    JoinSquad

    LeaveSquad

    Service.Join

    Service.Leave

19.  def UpdateSquadDetail(guid: PlanetSideGUID, toChannel: String, excluding: Iterable[Long], details: SquadDetail): Unit

    Send a message entailing some of the strategic information and the composition to the existing members of the squad.

    Send a message entailing some of the strategic information and the composition to the existing members of the squad. Also send the same information to any users who are watching the squad, potentially for want to join it. The squad-specific message is contingent on finding the squad's features using the unique identifier number and, from that, reporting to the specific squad's messaging channel. Anyone watching the squad will always be updated the given details.

    guid

    the unique squad identifier number to be used for the squad detail message

    toChannel

    the squad broadcast channel name

    excluding

    the explicit unique character identifier numbers of individuals who should not receive the message

    details

    the squad details to be included in the message

    See also

    DisplaySquad

    Publish

    SquadDetail

    SquadResponse.Detail

20.  def UpdateSquadDetail(features: SquadFeatures, details: SquadDetail): Unit

    Send a message entailing some of the strategic information and the composition to the existing members of the squad.

    Send a message entailing some of the strategic information and the composition to the existing members of the squad.

    features

    information about the squad

    details

    the squad details to be included in the message

    See also

    SquadResponse.Detail

    UpdateSquadDetail(PlanetSideGUID, PlanetSideGUID, List[Long], SquadDetail)

21.  def UpdateSquadDetail(features: SquadFeatures): Unit

    Send a message entailing the strategic information and the composition of the squad to the existing members of the squad.

    Send a message entailing the strategic information and the composition of the squad to the existing members of the squad.

    features

    the squad

    See also

    SquadService.PublishFullDetails

    UpdateSquadDetail(PlanetSideGUID, PlanetSideGUID, List[Long], SquadDetail)

22.  val UserEvents: LongMap[ActorRef]

    This collection contains the message-sending contact reference for individuals.

    This collection contains the message-sending contact reference for individuals. When the user joins the SquadService with a Service.Join message that includes their unique character identifier, the origin ActorRef is added as a subscription. It is maintained until they disconnect entirely. The subscription is anticipated to belong to an instance of SessionActor.
    key - unique character identifier number; value - ActorRef reference for that character

    See also

    Service.Join

23.  final def asInstanceOf[T0]: T0

    Definition Classes

    Any

24.  def clone(): AnyRef

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.CloneNotSupportedException]) @native()

25.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

26.  def equals(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef → Any

27.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.Throwable])

28.  final def getClass(): Class[_ <: AnyRef]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

29.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

30.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

31.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

32.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

33.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

34.  def postStop(): Unit
35.  final def synchronized[T0](arg0: => T0): T0

    Definition Classes

    AnyRef

36.  def toString(): String

    Definition Classes

    AnyRef → Any

37.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

38.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

39.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException]) @native()