Class/Object

net.psforever.objects.serverobject

ServerObjectBuilder

Related Docs: object ServerObjectBuilder | package serverobject

Permalink

class ServerObjectBuilder[A <: PlanetSideServerObject] extends AnyRef

Customizable native entity instantiation logic at the ZoneMap level. Produces environmental constants such as Terminal objects and Door objects.

ZoneMap is the expected position where this class is defined. Within Zone.Init is where this class is expected to be fully executed. The former is a blueprint which provides as many emitted entities based on how many Zone objects utilize it. constructor is required to have the form (Int, ActorContext) => A by the point where it executes due to invocation of the Build method. For that reason, it must exist in an Actor which has an ActorContext to lend, hence the Zone's Actor. Furthermore, the requirement of a NumberPoolHub means the region is accessible to and defined by a closed number space, which is also the Zone. It utilizes those qualities of the enclosing region to construct the entity within that region.

Example: ServerObjectBuilder(n, function)
Example: new ServerBuilderObject[A](n, function), where function is a (Int,Context)=>A

A

any object that extends from PlanetSideServerObject that will be produced by this class; can be inferred from the output of constructor

Source
ServerObjectBuilder.scala
See also

Zone.Init

ZoneMap

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerObjectBuilder
  2. AnyRef
  3. 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 ServerObjectBuilder(id: Int, constructor: ConstructorType[A])

    Permalink

    id

    the unique id that will be assigned to this entity

    constructor

    the logic that initializes the emitted entity

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 ServerObjectBuilder[A] to any2stringadd[ServerObjectBuilder[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (ServerObjectBuilder[A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServerObjectBuilder[A] to ArrowAssoc[ServerObjectBuilder[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. def Build(implicit context: ActorContext = null, guid: NumberPoolHub = null): A

    Permalink

    Instantiate and configure the given server object.

    Instantiate and configure the given server object. Specific configuration should have been handled by curried parameters into constructor, i.e., constructor(foo : Bar) => constructor(Int, ActorContext) => A. The main activity performed locally registers the created object to the provided number space.

    context

    a context to allow the object to properly set up ActorSystem functionality; defaults to null

    guid

    the local globally unique identifier system to complete the process of object introduction; defaults to null

    returns

    the object that was created and integrated into the Zone

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. def ensuring(cond: (ServerObjectBuilder[A]) ⇒ Boolean, msg: ⇒ Any): ServerObjectBuilder[A]

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

  10. def ensuring(cond: (ServerObjectBuilder[A]) ⇒ Boolean): ServerObjectBuilder[A]

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

  11. def ensuring(cond: Boolean, msg: ⇒ Any): ServerObjectBuilder[A]

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

  12. def ensuring(cond: Boolean): ServerObjectBuilder[A]

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

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServerObjectBuilder[A] to StringFormat[ServerObjectBuilder[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  18. def hashCode(): Int

    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. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. def →[B](y: B): (ServerObjectBuilder[A], B)

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ServerObjectBuilder[A] to any2stringadd[ServerObjectBuilder[A]]

Inherited by implicit conversion StringFormat from ServerObjectBuilder[A] to StringFormat[ServerObjectBuilder[A]]

Inherited by implicit conversion Ensuring from ServerObjectBuilder[A] to Ensuring[ServerObjectBuilder[A]]

Inherited by implicit conversion ArrowAssoc from ServerObjectBuilder[A] to ArrowAssoc[ServerObjectBuilder[A]]

Ungrouped