TriggerEffectMessage

Dispatched by the server to cause a client to display a special graphical effect.

The effect being triggered can be based around a specific game object or replayed freely, absent of an anchoring object. If object-based then the kinds of effects that can be activated are specific to the object. If unbound, then a wider range of effects can be displayed. Regardless, one category will rarely ever be activated under the same valid conditions of the other category. For example, the effect "on" will only work on objects that accept "on" normally, like a deployed motionalarmsensor. The effect "spawn_object_effect" can be applied anywhere in the environment; but, it can not be activated in conjunction with an existing object.

object_guid: an object that accepts the effect
effect: the name of the effect
unk: na; when activating an effect on an existing object
location: an optional position where the effect will be displayed; when activating an effect independently

Source: TriggerEffectMessage.scala

Linear Supertypes

Product, Equals, PlanetSideGamePacket, PlanetSidePacket, Serializable, Serializable, AnyRef, Any

Instance Constructors

new TriggerEffectMessage(object_guid: PlanetSideGUID, effect: String, unk: Option[TriggeredEffect] = None, location: Option[TriggeredEffectLocation] = None)

object_guid
an object that accepts the effect
effect
the name of the effect
unk
na; when activating an effect on an existing object
location
an optional position where the effect will be displayed; when activating an effect independently

Type Members

type Packet = TriggerEffectMessage

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from TriggerEffectMessage to any2stringadd[TriggerEffectMessage] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (TriggerEffectMessage, B)

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

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

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val effect: String

the name of the effect
def encode: Attempt[BitVector]

Definition Classes
TriggerEffectMessage → PlanetSidePacket
def ensuring(cond: (TriggerEffectMessage) ⇒ Boolean, msg: ⇒ Any): TriggerEffectMessage

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

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

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

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

Definition Classes
AnyRef
def finalize(): Unit

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

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

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

Definition Classes
Any
val location: Option[TriggeredEffectLocation]

an optional position where the effect will be displayed; when activating an effect independently
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val object_guid: PlanetSideGUID

an object that accepts the effect
def opcode: GamePacketOpcode.Value

Definition Classes
TriggerEffectMessage → PlanetSideGamePacket → PlanetSidePacket
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val unk: Option[TriggeredEffect]

na; when activating an effect on an existing object
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (TriggerEffectMessage, B)

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

Related Docs: object TriggerEffectMessage | package game

final case class TriggerEffectMessage(object_guid: PlanetSideGUID, effect: String, unk: Option[TriggeredEffect] = None, location: Option[TriggeredEffectLocation] = None) extends PlanetSideGamePacket with Product with Serializable

Instance Constructors

new TriggerEffectMessage(object_guid: PlanetSideGUID, effect: String, unk: Option[TriggeredEffect] = None, location: Option[TriggeredEffectLocation] = None)

Type Members

type Packet = TriggerEffectMessage

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (TriggerEffectMessage, B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val effect: String

def encode: Attempt[BitVector]

def ensuring(cond: (TriggerEffectMessage) ⇒ Boolean, msg: ⇒ Any): TriggerEffectMessage

def ensuring(cond: (TriggerEffectMessage) ⇒ Boolean): TriggerEffectMessage

def ensuring(cond: Boolean, msg: ⇒ Any): TriggerEffectMessage

def ensuring(cond: Boolean): TriggerEffectMessage

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val location: Option[TriggeredEffectLocation]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val object_guid: PlanetSideGUID

def opcode: GamePacketOpcode.Value

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

val unk: Option[TriggeredEffect]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def →[B](y: B): (TriggerEffectMessage, B)

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 TriggerEffectMessage to any2stringadd[TriggerEffectMessage]

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

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

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

Ungrouped