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 AddInvite(invitedPlayer: Long, invite: Invitation): Option[Invitation]

   Assign a provided invitation object to either the active or inactive position for a player.
   
   The determination for the active position is whether or not something is currently in the active position or whether some mechanism tried to shift invitation object into the active position but found nothing to shift.

   Assign a provided invitation object to either the active or inactive position for a player.
   
   The determination for the active position is whether or not something is currently in the active position or whether some mechanism tried to shift invitation object into the active position but found nothing to shift. If an invitation object originating from the reported player already exists, a new one is not appended to the inactive queue. This method should always be used as the entry point for the active and inactive invitation options or as a part of the entry point for the aforesaid options.

   invitedPlayer

   the unique character identifier for the player being invited; in actuality, represents the player who will address the invitation object

   invite

   the "new" invitation envelop object

   returns

   an optional invite; the invitation object in the active invite position; None, if it is not added to either the active option or inactive position

   See also

   AddInviteAndRespond

   AltAddInviteAndRespond

5.  def AddInviteAndRespond(invitedPlayer: Long, targetInvite: Invitation, invitingPlayer: Long, name: String, autoApprove: Boolean = false): Unit

   Enqueue a newly-submitted invitation object either as the active position or into the inactive positions and dispatch a response for any invitation object that is discovered.

   Enqueue a newly-submitted invitation object either as the active position or into the inactive positions and dispatch a response for any invitation object that is discovered. Implementation of a workflow.

   invitedPlayer

   the unique character identifier for the player being invited; in actuality, represents the player who will address the invitation object

   targetInvite

   a comparison invitation object

   invitingPlayer

   the unique character identifier for the player who invited the former

   name

   a name to be used in message composition

   See also

   AddInvite

   indirectInviteResp

6.  def Allowed(charId: Long, list: List[Long]): List[Long]

   This player has been refused to join squads by these squad leaders, or to form squads with these other players.

   This player has been refused to join squads by these squad leaders, or to form squads with these other players. They are now allowed.

   charId

   the player who is being refused

   list

   the players who was previously refused

   returns

   the list of other players who have refused this player

7.  def Allowed(charId: Long, permittedCharId: Long): List[Long]

   This player has been refused to join squads by this squad leaders, or to form squads with this other player.

   This player has been refused to join squads by this squad leaders, or to form squads with this other player. They are now allowed.

   charId

   the player who is being refused

   permittedCharId

   the player who was previously refused

   returns

   the list of other players who have refused this player

8.  def AltAddInviteAndRespond(invitedPlayer: Long, targetInvite: Invitation, invitingPlayer: Long, name: String, autoApprove: Boolean = false): Unit

   Enqueue a newly-submitted invitation object either as the active position or into the inactive positions and dispatch a response for any invitation object that is discovered.

   Enqueue a newly-submitted invitation object either as the active position or into the inactive positions and dispatch a response for any invitation object that is discovered. Implementation of a workflow.

   invitedPlayer

   the unique character identifier for the player being invited

   targetInvite

   a comparison invitation object

   invitingPlayer

   the unique character identifier for the player who invited the former

   name

   a name to be used in message composition

   See also

   AddInvite

   altIndirectInviteResp

9.  def CleanUpAllInvitesToSquad(features: SquadFeatures): Unit

   Remove all invitation objects that are related to the particular squad.

   Remove all invitation objects that are related to the particular squad. Specifically used to safely disarm obsolete invitation objects by specific criteria. Affects all invitation object types and all data structures that deal with the squad.

   features

   the squad identifier

   See also

   RequestRole

   IndirectInvite

   LookingForSquadRoleInvite

   ProximityInvite

   RemoveInvite

   VacancyInvite

10.  def CleanUpAllInvitesWithPlayer(charId: Long): Unit

    Remove all active and inactive invitation objects that are related to the particular player.

    Remove all active and inactive invitation objects that are related to the particular player. Specifically used to safely disarm obsolete invitation objects by specific criteria. Affects all invitation object types and all data structures that deal with the player.

    charId

    the player's unique identifier number

    See also

    RequestRole

    IndirectInvite

    LookingForSquadRoleInvite

    RemoveInvite

    CleanUpAllProximityInvites

    VacancyInvite

11.  def CleanUpAllProximityInvites(charId: Long): Unit

    Remove all active and inactive proximity squad invites.

    Remove all active and inactive proximity squad invites. This is related to recruitment from the perspective of the recruiter.

    charId

    the player

12.  def CleanUpInvitesForSquadAndPosition(features: SquadFeatures, position: Int): Unit

    Remove all invitation objects that are related to the particular squad and the particular role in the squad.

    Remove all invitation objects that are related to the particular squad and the particular role in the squad. Specifically used to safely disarm obsolete invitation objects related to the specific criteria. Affects only certain invitation object types including "player requesting role" and "leader requesting recruiting role".

    features

    the squad

    position

    the role position index

    See also

    RemoveActiveInvitesForSquadAndPosition

    RemoveQueuedInvitesForSquadAndPosition

13.  def CleanUpProximityInvites(features: SquadFeatures): Unit

    Remove all active and inactive proximity squad invites for a specific squad.

    Remove all active and inactive proximity squad invites for a specific squad.

    features

    the squad

14.  def CleanUpQueuedInvites(charId: Long): Unit

    Remove all inactive invites associated with this player.

    Remove all inactive invites associated with this player.

    charId

    the unique character identifier for the player being invited; in actuality, represents the player who will address the invitation object

    returns

    a list of the removed inactive invitation objects

15.  def CleanUpQueuedInvitesForSquadAndPosition(features: SquadFeatures, position: Int): Unit

    Remove all inactive invitation objects that are related to the particular squad and the particular role in the squad.

    Remove all inactive invitation objects that are related to the particular squad and the particular role in the squad. Specifically used to safely disarm obsolete invitation objects by specific criteria. Affects only certain invitation object types.

    features

    the squa

    position

    the role position index

    See also

    RequestRole

    LookingForSquadRoleInvite

    CleanUpInvitesForSquadAndPosition

16.  def CleanUpSquadFeatures(removed: List[Long], features: SquadFeatures, position: Int): Unit
17.  def DeliverAcceptanceMessages(squadLeader: Long, joiningPlayer: Long, joiningPlayerName: String): Unit
18.  def EnsureEmptySquad(features: SquadFeatures): Boolean

    Determine whether a player is sufficiently unemployed and has no grand delusions of being a squad leader.

    Determine whether a player is sufficiently unemployed and has no grand delusions of being a squad leader.

    features

    the squad

    returns

    true, if the target player possesses no squad or a squad that is suitably nonexistent; false, otherwise

    See also

    CloseSquad

19.  def EnsureEmptySquad(features: Option[SquadFeatures]): Boolean

    Determine whether a player is sufficiently unemployed and has no grand delusions of being a squad leader.

    Determine whether a player is sufficiently unemployed and has no grand delusions of being a squad leader.

    features

    an optional squad

    returns

    true, if the target player possesses no squad or the squad is nonexistent; false, otherwise

    See also

    CloseSquad

20.  def FindSoldiersWithinScopeAndInvite(invitingPlayer: Member, features: SquadFeatures, position: Int, scope: List[Avatar], excluded: List[Long], invitationEnvelopFunc: (Member, SquadFeatures, Int) => Invitation): Option[Long]
21.  def HandleRequestRole(player: Player, features: SquadFeatures, bid: Invitation): Boolean

    The functionality for handling indirection for handling one player requesting a specific squad role or when messaging the squad leader about an invite.
    
    At this point in the squad join process, the only consent required is that of the squad leader.

    The functionality for handling indirection for handling one player requesting a specific squad role or when messaging the squad leader about an invite.
    
    At this point in the squad join process, the only consent required is that of the squad leader. An automatic consent flag exists on the squad; but, if that is not set, then the squad leader must be asked whether or not to accept or to reject the recruit. If the squad leader changes in the middle or the latter half of the process, the invitation may still fail even if the old squad leader accepts. If the squad leader changes in the middle of the latter half of the process, the inquiry might be posed again of the new squad leader, of whether to accept or to reject the recruit.

    player

    the player who wants to join the squad

    features

    the squad

    bid

    the Invitation object that was the target of this request

    returns

    true, if the player is not denied the possibility of joining the squad; false, otherwise, of it the squad does not exist

22.  def HandleRequestRole(player: Player, bid: IndirectInvite): Boolean

    An overloaded entry point to the functionality for handling indirection when messaging the squad leader about an invite.

    An overloaded entry point to the functionality for handling indirection when messaging the squad leader about an invite.

    player

    the player who wants to join the squad

    bid

    a specific kind of Invitation object

    returns

    true, if the player is not denied the possibility of joining the squad; false, otherwise, of it the squad does not exist

23.  def HandleRequestRole(player: Player, bid: RequestRole): Boolean

    An overloaded entry point to the functionality for handling one player requesting a specific squad role.

    An overloaded entry point to the functionality for handling one player requesting a specific squad role.

    player

    the player who wants to join the squad

    bid

    a specific kind of Invitation object

    returns

    true, if the player is not denied the possibility of joining the squad; false, otherwise, of it the squad does not exist

24.  def HandleVacancyInvite(features: SquadFeatures, invitedPlayer: Long, invitingPlayer: Long, recruit: Player): Option[(SquadFeatures, Int)]

    Resolve an invitation to a general, not guaranteed, position in someone else's squad.
    
    Originally, the instigating type of invitation object was a "VacancyInvite" which indicated a type of undirected invitation extended from the squad leader to another player but the resolution is generalized enough to suffice for a number of invitation objects.

    Resolve an invitation to a general, not guaranteed, position in someone else's squad.
    
    Originally, the instigating type of invitation object was a "VacancyInvite" which indicated a type of undirected invitation extended from the squad leader to another player but the resolution is generalized enough to suffice for a number of invitation objects. First, an actual position is determined; then, the squad is tested for recruitment conditions, including whether the person who solicited the would-be member is still the squad leader. If the recruitment is manual and the squad leader is not the same as the recruiting player, then the real squad leader is sent an indirect query regarding the player's eligibility. These IndirectInvite invitation objects also are handled by calls to HandleVacancyInvite.

    features

    the squad

    invitedPlayer

    the unique character identifier for the player being invited

    invitingPlayer

    the unique character identifier for the player who invited the former

    recruit

    the player being invited

    returns

    the squad object and a role position index, if properly invited; None, otherwise

    See also

    AltAddInviteAndRespond

    IndirectInvite

    SquadFeatures::AutoApproveInvitationRequests

    VacancyInvite

25.  def InviteResponseTemplate(indirectInviteFunc: (IndirectInvite, Player, Long, Long, String) => Boolean)(targetInvite: Invitation, actualInvite: Option[Invitation], invitedPlayer: Long, invitingPlayer: Long, name: String): Unit

    A branched response for processing (new) invitation objects that have been submitted to the system.
    
    A comparison is performed between the original invitation object and an invitation object that represents the potential modification or redirection of the current active invitation obect.

    A branched response for processing (new) invitation objects that have been submitted to the system.
    
    A comparison is performed between the original invitation object and an invitation object that represents the potential modification or redirection of the current active invitation obect. Any further action is only performed when an "is equal" comparison is true. When passing, the system publishes up to two messages to users that would anticipate being informed of squad join activity.

    indirectInviteFunc

    the method that cans the responding behavior should an IndirectInvite object being consumed

    targetInvite

    a comparison invitation object; represents the unmodified, unadjusted invite

    actualInvite

    a comparaison invitation object; proper use of this field should be the output of another process upon the following actualInvite

    invitedPlayer

    the unique character identifier for the player being invited in actuality, represents the player who will address the invitation object

    invitingPlayer

    the unique character identifier for the player who invited the former

    name

    a name to be used in message composition

26.  def JoinSquad(player: Player, features: SquadFeatures, position: Int): Boolean

    Behaviors and exchanges necessary to complete the fulfilled recruitment process for the squad role.
    
    This operation is fairly safe to call whenever a player is to be inducted into a squad.

    Behaviors and exchanges necessary to complete the fulfilled recruitment process for the squad role.
    
    This operation is fairly safe to call whenever a player is to be inducted into a squad. The aforementioned player must have a callback retained in subs.UserEvents and conditions imposed by both the role and the player must be satisfied.

    player

    the new squad member; this player is NOT the squad leader

    features

    the squad the player is joining

    position

    the squad member role that the player will be filling

    returns

    true, if the player joined the squad in some capacity; false, if the player did not join the squad or is already a squad member

    See also

    CleanUpAllInvitesWithPlayer

    Squad.isAvailable

    Squad.Switchboard

    SquadSubscriptionEntity.MonitorSquadDetails

    SquadSubscriptionEntity.Publish

    SquadSubscriptionEntity.Join

    SquadSubscriptionEntity.UserEvents

27.  def NextInvite(invitedPlayer: Long): Option[Invitation]

    Select the next invitation object to be shifted into the active position.
    
    The determination for the active position is whether or not something is currently in the active position or whether some mechanism tried to shift invitation object into the active position but found nothing to shift.

    Select the next invitation object to be shifted into the active position.
    
    The determination for the active position is whether or not something is currently in the active position or whether some mechanism tried to shift invitation object into the active position but found nothing to shift. After handling of the previous invitation object has completed or finished, the temporary block on adding new invitations is removed and any queued inactive invitation on the head of the inactive queue is shifted into the active position.

    invitedPlayer

    the unique character identifier for the player being invited; in actuality, represents the player who will address the invitation object

    returns

    an optional invite; the invitation object in the active invite position; None, if not shifted into the active position

    See also

    NextInviteAndRespond

28.  def NextInviteAndRespond(invitedPlayer: Long): Unit

    Select the next invitation object to be shifted into the active position and dispatch a response for any invitation object that is discovered.

    Select the next invitation object to be shifted into the active position and dispatch a response for any invitation object that is discovered.

    invitedPlayer

    the unique character identifier for the player being invited; in actuality, represents the player who will address the invitation object

    See also

    NextInvite

    RespondToInvite

29.  def Refused(charId: Long, list: List[Long]): List[Long]

    This player has been refused to join squads by these squad leaders, or to form squads with these other players.

    This player has been refused to join squads by these squad leaders, or to form squads with these other players.

    charId

    the player who is being refused

    list

    the players who refused

    returns

    the list of other players who have refused this player

30.  def Refused(charId: Long, refusedCharId: Long): List[Long]

    This player has been refused to join squads by this squad leaders, or to form squads with this other player.

    This player has been refused to join squads by this squad leaders, or to form squads with this other player.

    charId

    the player who is being refused

    refusedCharId

    the player who refused

    returns

    the list of other players who have refused this player

31.  def Refused(charId: Long): List[Long]

    This player has been refused to join squads by these players, or to form squads with these players.

    This player has been refused to join squads by these players, or to form squads with these players.

    charId

    the player who refused other players

    returns

    the list of other players who have refused this player

32.  def ReloadProximityInvite(scope: List[Avatar], rejectingPlayer: Long, features: SquadFeatures, position: Int): Unit
33.  def ReloadSearchForRoleInvite(scope: List[Avatar], rejectingPlayer: Long, features: SquadFeatures, position: Int): Unit
34.  def RemoveActiveInvitesForSquadAndPosition(guid: PlanetSideGUID, position: Int): List[Long]

    Remove all active invitation objects that are related to the particular squad and the particular role in the squad.

    Remove all active invitation objects that are related to the particular squad and the particular role in the squad. Specifically used to safely disarm obsolete invitation objects related to the specific criteria. Affects only certain invitation object types including "player requesting role" and "leader requesting recruiting role".

    guid

    the squad identifier

    position

    the role position index

    returns

    the character ids of all players whose invites were removed

    See also

    RequestRole

    LookingForSquadRoleInvite

    ProximityInvite

    RemoveInvite

35.  def RemoveInvite(invitedPlayer: Long): Option[Invitation]

    Remove any invitation object from the active position.

    Remove any invitation object from the active position. Flag the temporary field to indicate that the active position, while technically available, should not yet have a new invitation object shifted into it yet. This is the "proper" way to demote invitation objects from the active position whether or not they are to be handled except in cases of manipulative cleanup.

    invitedPlayer

    the unique character identifier for the player being invited; in actuality, represents the player who will address the invitation object

    returns

    an optional invite; the invitation object formerly in the active invite position; None, if no invitation was in the active position

    See also

    NextInvite

    NextInviteAndRespond

36.  def RemoveQueuedInvitesForSquadAndPosition(guid: PlanetSideGUID, position: Int): List[Long]

    Remove all inactive invitation objects that are related to the particular squad and the particular role in the squad.

    Remove all inactive invitation objects that are related to the particular squad and the particular role in the squad. Specifically used to safely disarm obsolete invitation objects by specific criteria. Affects only certain invitation object types.

    guid

    the squad identifier

    position

    the role position index

    returns

    the character ids of all players whose invites were removed

    See also

    RequestRole

    LookingForSquadRoleInvite

    CleanUpInvitesForSquadAndPosition

37.  def RespondToInvite(invitedPlayer: Long, invite: Invitation): Unit

    Compose the response to an invitation.

    Compose the response to an invitation. Use standard handling methods for IndirectInvite invitation envelops.

    invitedPlayer

    the unique character identifier for the player being invited; in actuality, represents the player who will address the invitation object

    invite

    the invitation envelope used to recover information about the action being taken

    See also

    InviteResponseTemplate

38.  def ShiftInvitesToPromotedSquadLeader(sponsoringPlayer: Long, promotedPlayer: Long): Unit
39.  def SquadActionDefinitionAutoApproveInvitationRequests(tplayer: Player, features: SquadFeatures): Unit
40.  def SquadActionDefinitionCancelFind(lSquadOpt: Option[SquadFeatures]): Unit
41.  def SquadActionDefinitionCancelSelectRoleForYourself(tplayer: Player, features: SquadFeatures): Unit

    the following action can be performed by anyone who has tried to join a squad

42.  def SquadActionDefinitionFindLfsSoldiersForRole(tplayer: Player, position: Int, features: SquadFeatures): Unit
43.  def SquadActionDefinitionSelectRoleForYourselfAsInvite(tplayer: Player, features: SquadFeatures, position: Int): Unit

    the following action can be performed by an unaffiliated player

44.  def SquadActionMembershipAcceptInvite(tplayer: Player, invitedPlayer: Long, acceptedInvite: Option[Invitation], invitedPlayerSquadOpt: Option[SquadFeatures]): Unit
45.  def SquadMembershipAcceptInviteAction(invitingPlayer: Player, player: Player, invitedPlayer: Long): Unit
46.  def altIndirectInviteResp(invite: IndirectInvite, player: Player, invitedPlayer: Long, invitingPlayer: Long, name: String): Boolean

    Component method used for the response behavior for processing the invitation object as an IndirectInvite object.

    Component method used for the response behavior for processing the invitation object as an IndirectInvite object.

    invite

    the original invitation object that started this process

    player

    the target of the response and invitation

    invitedPlayer

    the unique character identifier for the player being invited in actuality, represents the player who will address the invitation object

    invitingPlayer

    the unique character identifier for the player who invited the former

    name

    a name to be used in message composition

    returns

    na

    See also

    HandleRequestRole

47.  final def asInstanceOf[T0]: T0

    Definition Classes

    Any

48.  def canEnrollInSquad(features: SquadFeatures, charId: Long): Boolean
49.  def clone(): AnyRef

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

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

50.  def createIndirectInvite(player: Player, invitingPlayer: Long, features: SquadFeatures): Unit
51.  def createRequestRole(player: Player, features: SquadFeatures, position: Int): Unit
52.  def createSpontaneousInvite(player: Player, invitedPlayer: Long): Unit
53.  def createVacancyInvite(player: Player, invitedPlayer: Long, features: SquadFeatures): Unit
54.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

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

    Definition Classes

    AnyRef → Any

56.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

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

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

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

58.  def handleAcceptance(player: Player, charId: Long, squadOpt: Option[SquadFeatures]): Unit
59.  def handleCancelling(cancellingPlayer: Long): Unit
60.  def handleCleanup(charId: Long): Unit
61.  def handleClosingSquad(features: SquadFeatures): Unit
62.  def handleDefinitionAction(player: Player, action: packet.game.SquadAction, features: SquadFeatures): Unit
63.  def handleDisbanding(features: SquadFeatures): Unit
64.  def handleJoin(charId: Long): Unit
65.  def handleLeave(charId: Long): Unit
66.  def handlePromotion(sponsoringPlayer: Long, promotedPlayer: Long): Unit
67.  def handleProximityInvite(zone: Zone, invitingPlayer: Long, features: SquadFeatures): Unit
68.  def handleRejection(tplayer: Player, rejectingPlayer: Long, squadsToLeaders: List[(PlanetSideGUID, Long)]): Unit
69.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

70.  def indirectInviteResp(invite: IndirectInvite, player: Player, invitedPlayer: Long, invitingPlayer: Long, name: String): Boolean

    Component method used for the response behavior for processing the invitation object as an IndirectInvite object.

    Component method used for the response behavior for processing the invitation object as an IndirectInvite object.

    invite

    the original invitation object that started this process

    player

    the target of the response and invitation

    invitedPlayer

    the unique character identifier for the player being invited; in actuality, represents the player who will address the invitation object; not useful here

    invitingPlayer

    the unique character identifier for the player who invited the former; not useful here

    name

    a name to be used in message composition; not useful here

    returns

    na

    See also

    HandleRequestRole

71.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

72.  def moveOverPromotedInvites(targetPlayer: Long, convertableInvites: List[Invitation], otherInvitations: List[Invitation]): Unit
73.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

74.  def notLeaderOfThisSquad(squadsToLeaders: List[(PlanetSideGUID, Long)], guid: PlanetSideGUID, charId: Long): Boolean
75.  def notLimitedByEnrollmentInSquad(squadOpt: Option[SquadFeatures], charId: Long): Boolean
76.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

77.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

78.  def postStop(): Unit
79.  def resendActiveInvite(charId: Long): Unit
80.  final def synchronized[T0](arg0: => T0): T0

    Definition Classes

    AnyRef

81.  def toString(): String

    Definition Classes

    AnyRef → Any

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()