Class/Object

net.psforever.packet.game

BattleplanMessage

Related Docs: object BattleplanMessage | package game

Permalink

final case class BattleplanMessage(char_id: Long, player_name: String, zone_id: Int, diagrams: List[BattleDiagramAction]) extends PlanetSideGamePacket with Product with Serializable

Share drawn images and words on the tactical map among a group of players.

Each packet usually contains a small portion of an image, herein called a "diagram." BattleplanMessage packets are accumulative towards a full diagram. Moreover, rather than the player_name, each diagram is associated on a client by the char_id field. Only squad leaders and platoon leaders can draw on the map and share with other players in their squad or platoon.

To start drawing, a would-be artist must have all clients who will receive their diagrams acknowledge a StartDrawing action. The char_id with this StartDrawing will associate all diagrams submitted with the same char_id's portfolio. Multiple portfolio definitions may exist on a client at a given time and each will manage their own diagrams. When a given portfolio submits a StopDrawing action that is received, the previous diagrams associated with it will be cleared. That char_id will no longer accept diagrams on that client. Other portfolios will continue to accept diagrams as initialized. When no portfolios are being accepted, the "Toggle -> Battleplan" button on that client's tactical map will be disabled. When there is at least one portfolio accepted, the "Battleplan" button will be functional and can be toggled.

To construct line segments, chain StrokeTwo diagrams in the given packet entry. Each defined point will act like a successive vertex in a chain of segments. Any non-vertex entry in between entries, e.g., a change of line color, will break the chain of line segments. For example:
RED-A-B-C will construct red lines segments A-B and B-C.
RED-A-B-GREEN-C will only construct a red line segement A-B.
RED-A-B-GREEN-C-D will construct a red line segement A-B and a green line segment C-D.
(Default line color, if none is declared specifically, is gray.)

To construct a message, define a point to act as the center baseline for the text. The message will be written above and outwards from that point. Messages do not carry properties over from line segments - they set their own color and do not have line thickness. Any single portfolio may have only fifteen messages written to the tactical map at a time.

char_id

na; same as in CharacterInfoMessage

player_name

the player who contributed this battle plan

zone_id

on which continent the battle plan will be overlaid; can identify as "no zone" 0 when performing instructions not specific to drawing

diagrams

a list of the itemized actions that will construct this plan or are used to modify the plan

Source
BattleplanMessage.scala
Linear Supertypes
Product, Equals, PlanetSideGamePacket, PlanetSidePacket, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BattleplanMessage
  2. Product
  3. Equals
  4. PlanetSideGamePacket
  5. PlanetSidePacket
  6. Serializable
  7. Serializable
  8. AnyRef
  9. 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 BattleplanMessage(char_id: Long, player_name: String, zone_id: Int, diagrams: List[BattleDiagramAction])

    Permalink

    char_id

    na; same as in CharacterInfoMessage

    player_name

    the player who contributed this battle plan

    zone_id

    on which continent the battle plan will be overlaid; can identify as "no zone" 0 when performing instructions not specific to drawing

    diagrams

    a list of the itemized actions that will construct this plan or are used to modify the plan

Type Members

  1. type Packet = BattleplanMessage

    Permalink

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from BattleplanMessage to ArrowAssoc[BattleplanMessage] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. val char_id: Long

    Permalink

    na; same as in CharacterInfoMessage

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val diagrams: List[BattleDiagramAction]

    Permalink

    a list of the itemized actions that will construct this plan or are used to modify the plan

  10. def encode: Attempt[BitVector]

    Permalink
    Definition Classes
    BattleplanMessagePlanetSidePacket
  11. def ensuring(cond: (BattleplanMessage) ⇒ Boolean, msg: ⇒ Any): BattleplanMessage

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  16. def finalize(): Unit

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  23. def opcode: GamePacketOpcode.Value

    Permalink
  24. val player_name: String

    Permalink

    the player who contributed this battle plan

  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  26. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. val zone_id: Int

    Permalink

    on which continent the battle plan will be overlaid; can identify as "no zone" 0 when performing instructions not specific to drawing

  30. def [B](y: B): (BattleplanMessage, B)

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

Inherited from Product

Inherited from Equals

Inherited from PlanetSideGamePacket

Inherited from PlanetSidePacket

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped