GUIDTask

object GUIDTask

The basic compiled tasks for assigning (registering) and revoking (unregistering) globally unique identifiers.

Almost all of these functions will be invoked from WorldSessionActor. Some of the "unregistering" functions will invoke on delayed Service operations, indicating behavior that is not user/observer dependent. The object's (current) Zone must also be knowable since the GUID systems are tied to individual zones. For simplicity, all functions have the same format where the hook into the GUID system is an implicit parameter. It will get passed from the more complicated functions down into the less complicated functions, until it has found the basic number assignment functionality.

All functions produce a TaskBundle container object or a list of TaskBundle container objects that is expected to be used by a TaskBundle container. These "task containers" can also be unpackaged into their component tasks, sorted into other containers, and combined with other tasks to enact more complicated sequences of operations. Almost all tasks have an explicit registering and an unregistering activity defined for it.

Source: GUIDTask.scala

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

GUIDTask
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Type Members

case class RegisterObjectTask(guid: UniqueNumberOps, obj: IdentifiableEntity, pool: String) extends Task with Product with Serializable
Attributes
protected
case class UnregisterObjectTask(guid: UniqueNumberOps, obj: IdentifiableEntity) extends Task with Product with Serializable
Attributes
protected

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def RegisterObjectTask(guid: UniqueNumberOps, obj: PlanetSideGameObject): RegisterObjectTask
def RegisterObjectTask(guid: UniqueNumberOps, obj: IdentifiableEntity): RegisterObjectTask
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
def registerAvatar(guid: UniqueNumberOps, tplayer: Player): TaskBundle
Construct tasking that registers an object with a globally unique identifier selected from a pool of numbers, as a Player.

Player objects are far more complicated than Tools (but they are not Equipment).
Construct tasking that registers an object with a globally unique identifier selected from a pool of numbers, as a Player.

Player objects are far more complicated than Tools (but they are not Equipment). A player has an inventory in which it can hold a countable number of Equipment; and, this inventory holds a sub-inventory with its own countable number of Equipment. Although a process of completing and inserting Equipment into the inventories that looks orderly can be written, this function assumes that the player is already fully composed. Use this function for an sudden introduction of the player into his environment (as defined by the scope of the unique number system). For working with processes concerning these "orderly insertions," a task built of lesser registration tasks and supporting tasks should be written instead.
guid
implicit reference to a unique number system
tplayer
the Player object being registered
returns
a TaskBundle message
def registerDeployableTurret(guid: UniqueNumberOps, obj: PlanetSideGameObject with WeaponTurret): TaskBundle
def registerEquipment(guid: UniqueNumberOps, obj: Equipment): TaskBundle
Construct tasking that registers an object with a globally unique identifier selected from a pool of numbers, after determining whether the object is complex (Tool or Locker) or is simple.

The objects in this case are specifically Equipment, a subclass of the basic register-able IdentifiableEntity.
Construct tasking that registers an object with a globally unique identifier selected from a pool of numbers, after determining whether the object is complex (Tool or Locker) or is simple.

The objects in this case are specifically Equipment, a subclass of the basic register-able IdentifiableEntity. About five subclasses of Equipment exist, but they decompose into two groups - "complex objects" and "simple objects." "Simple objects" are most groups of Equipment and just their own GUID to be registered. "Complex objects" are just the Tool category of Equipment. They have internal objects that must also have their GUID's registered to function.

Using this function when passing unknown Equipment is recommended. The type will be sorted and the object will be handled according to its complexity level.
guid
implicit reference to a unique number system
obj
the Equipment object being registered
returns
a TaskBundle message
def registerInventory(guid: UniqueNumberOps, container: Container): List[TaskBundle]
Construct tasking that registers the objects that are within the given container's inventory with a globally unique identifier selected from a pool of numbers for each object.
Construct tasking that registers the objects that are within the given container's inventory with a globally unique identifier selected from a pool of numbers for each object.
guid
implicit reference to a unique number system
container
the storage unit in which objects can be found
returns
a list of TaskBundle messages
See also
GUIDTask.unregisterInventory
Container
def registerLocker(guid: UniqueNumberOps, obj: LockerEquipment): TaskBundle
Construct tasking that registers a LockerContainer object with a globally unique identifier selected from a pool of numbers.
Construct tasking that registers a LockerContainer object with a globally unique identifier selected from a pool of numbers.
guid
implicit reference to a unique number system
obj
the object being registered
returns
a TaskBundle message
See also
GUIDTask.unregisterLocker
def registerLocker(guid: UniqueNumberOps, obj: LockerContainer): TaskBundle
Construct tasking that registers a LockerContainer object with a globally unique identifier selected from a pool of numbers.
Construct tasking that registers a LockerContainer object with a globally unique identifier selected from a pool of numbers.
guid
implicit reference to a unique number system
obj
the object being registered
returns
a TaskBundle message
See also
GUIDTask.unregisterLocker
def registerObject(guid: UniqueNumberOps, obj: PlanetSideGameObject): TaskBundle
Construct tasking that registers an object with a globally unique identifier selected from a specific pool of numbers.
Construct tasking that registers an object with a globally unique identifier selected from a specific pool of numbers. Regardless of the complexity of the object provided to this function, only the current depth will be assigned a GUID.
guid
implicit reference to a unique number system
obj
the object being registered
returns
a TaskBundle message
def registerObject(guid: UniqueNumberOps, obj: IdentifiableEntity): TaskBundle
Construct tasking that registers an object with a globally unique identifier selected from a pool of numbers.
Construct tasking that registers an object with a globally unique identifier selected from a pool of numbers. Regardless of the complexity of the object provided to this function, only the current depth will be assigned a GUID. This is the most basic operation that all objects that can be assigned a GUID must perform.
guid
implicit reference to a unique number system
obj
the object being registered
returns
a TaskBundle message
def registerPlayer(guid: UniqueNumberOps, tplayer: Player): TaskBundle
Construct tasking that registers an object with a globally unique identifier selected from a pool of numbers, as a Player.

Similar to RegisterAvatar but the locker components are skipped.
Construct tasking that registers an object with a globally unique identifier selected from a pool of numbers, as a Player.

Similar to RegisterAvatar but the locker components are skipped.
guid
implicit reference to a unique number system
tplayer
the Player object being registered
returns
a TaskBundle message
def registerTool(guid: UniqueNumberOps, obj: Tool): TaskBundle
Construct tasking that registers an object with a globally unique identifier selected from a pool of numbers, as a Tool.

Tool objects are complicated by an internal structure informally called a "magazine feed." The objects in the magazine feed are called AmmoBox objects.
Construct tasking that registers an object with a globally unique identifier selected from a pool of numbers, as a Tool.

Tool objects are complicated by an internal structure informally called a "magazine feed." The objects in the magazine feed are called AmmoBox objects. Each AmmoBox object can be registered to a unique number system much like the Tool itself; and, each must be registered properly for the whole of the Tool to be communicated from the server to the client. While the matter has been abstracted for convenience, most Tool objects will have only one AmmoBox at a time and the common outlier will only be two.

Do not invoke this function unless certain the object will be of type Tool, else use a more general function to differentiate between simple and complex objects.
guid
implicit reference to a unique number system
obj
the Tool object being registered
returns
a TaskBundle message
See also
GUIDTask.registerEquipment
def registerVehicle(guid: UniqueNumberOps, vehicle: Vehicle): TaskBundle
Construct tasking that registers an object with a globally unique identifier selected from a pool of numbers, as a Vehicle.

Vehicle objects are far more complicated than Tools (but they are not Equipment).
Construct tasking that registers an object with a globally unique identifier selected from a pool of numbers, as a Vehicle.

Vehicle objects are far more complicated than Tools (but they are not Equipment). A vehicle has an inventory in which it can hold a countable number of Equipment; and, it may possess weapons (Tools, usually) that are firmly mounted on its outside. (This is similar to the holsters on a Player object but they can not be swapped out for other Equipment or for nothing.) Although a process of completing and inserting Equipment into the inventories that looks orderly can be written, this function assumes that the vehicle is already fully composed. Use this function for an sudden introduction of the vehicle into its environment (as defined by the scope of the unique number system). For working with processes concerning these "orderly insertions," a task built of lesser registration tasks and supporting tasks should be written instead.
guid
implicit reference to a unique number system
vehicle
the Vehicle object being registered
returns
a TaskBundle message
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
def unregisterAvatar(guid: UniqueNumberOps, tplayer: Player): TaskBundle
Construct tasking that unregisters a Player object from a globally unique identifier system.

This task performs an operation that reverses the effect of RegisterAvatar.
Construct tasking that unregisters a Player object from a globally unique identifier system.

This task performs an operation that reverses the effect of RegisterAvatar.
guid
implicit reference to a unique number system
tplayer
the Player object being unregistered
returns
a TaskBundle message
See also
GUIDTask.registerAvatar
def unregisterDeployableTurret(guid: UniqueNumberOps, obj: PlanetSideGameObject with WeaponTurret): TaskBundle
def unregisterEquipment(guid: UniqueNumberOps, obj: Equipment): TaskBundle
Construct tasking that registers an object with a globally unique identifier selected from a pool of numbers, after determining whether the object is complex (Tool or Locker) or is simple.

The objects in this case are specifically Equipment, a subclass of the basic register-able IdentifiableEntity.
Construct tasking that registers an object with a globally unique identifier selected from a pool of numbers, after determining whether the object is complex (Tool or Locker) or is simple.

The objects in this case are specifically Equipment, a subclass of the basic register-able IdentifiableEntity. About five subclasses of Equipment exist, but they decompose into two groups - "complex objects" and "simple objects." "Simple objects" are most groups of Equipment and just their own GUID to be registered. "Complex objects" are just the Tool category of Equipment. They have internal objects that must also have their GUID's registered to function.

Using this function when passing unknown Equipment is recommended. The type will be sorted and the object will be handled according to its complexity level.
guid
implicit reference to a unique number system
obj
the Equipment object being registered
returns
a TaskBundle message
def unregisterInventory(guid: UniqueNumberOps, container: Container): List[TaskBundle]
Construct tasking that unregisters the objects that are within the given container's inventory from a globally unique identifier system.
Construct tasking that unregisters the objects that are within the given container's inventory from a globally unique identifier system.
guid
implicit reference to a unique number system
container
the storage unit in which objects can be found
returns
a list of TaskBundle messages
See also
GUIDTask.registerInventory
Container
def unregisterLocker(guid: UniqueNumberOps, obj: LockerEquipment): TaskBundle
Construct tasking that unregisters a LockerContainer object from a globally unique identifier system.
Construct tasking that unregisters a LockerContainer object from a globally unique identifier system.
guid
implicit reference to a unique number system
obj
the object being unregistered
returns
a TaskBundle message
See also
GUIDTask.registerLocker
def unregisterLocker(guid: UniqueNumberOps, obj: LockerContainer): TaskBundle
Construct tasking that unregisters a LockerContainer object from a globally unique identifier system.
Construct tasking that unregisters a LockerContainer object from a globally unique identifier system.
guid
implicit reference to a unique number system
obj
the object being unregistered
returns
a TaskBundle message
See also
GUIDTask.registerLocker
def unregisterObject(guid: UniqueNumberOps, obj: IdentifiableEntity): TaskBundle
Construct tasking that unregisters an object from a globally unique identifier system.

This task performs an operation that reverses the effect of RegisterObjectTask.
Construct tasking that unregisters an object from a globally unique identifier system.

This task performs an operation that reverses the effect of RegisterObjectTask. It is the most basic operation that all objects that can have their GUIDs revoked must perform.
guid
implicit reference to a unique number system
obj
the object being unregistered
returns
a TaskBundle message
See also
GUIDTask.registerObjectTask
def unregisterPlayer(guid: UniqueNumberOps, tplayer: Player): TaskBundle
Construct tasking that unregisters a portion of a Player object from a globally unique identifier system.

Similar to UnregisterAvatar but the locker components are skipped.
Construct tasking that unregisters a portion of a Player object from a globally unique identifier system.

Similar to UnregisterAvatar but the locker components are skipped. This task performs an operation that reverses the effect of RegisterPlayer.
guid
implicit reference to a unique number system
tplayer
the Player object being unregistered
returns
a TaskBundle message
See also
GUIDTask.registerAvatar
def unregisterTool(guid: UniqueNumberOps, obj: Tool): TaskBundle
Construct tasking that unregisters an object from a globally unique identifier system after determining whether the object is complex (Tool or Locker) or is simple.

This task performs an operation that reverses the effect of RegisterEquipment.
Construct tasking that unregisters an object from a globally unique identifier system after determining whether the object is complex (Tool or Locker) or is simple.

This task performs an operation that reverses the effect of RegisterEquipment.
guid
implicit reference to a unique number system
obj
the Equipment object being unregistered
returns
a TaskBundle message
See also
GUIDTask.registerEquipment
def unregisterVehicle(guid: UniqueNumberOps, vehicle: Vehicle): TaskBundle
Construct tasking that unregisters a Vehicle object from a globally unique identifier system.

This task performs an operation that reverses the effect of RegisterVehicle.
Construct tasking that unregisters a Vehicle object from a globally unique identifier system.

This task performs an operation that reverses the effect of RegisterVehicle.
guid
implicit reference to a unique number system
vehicle
the Vehicle object being unregistered
returns
a TaskBundle message
See also
GUIDTask.registerVehicle
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Packages

GUIDTask

object GUIDTask

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

GUIDTask

object GUIDTask

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

GUIDTask