PSF-LoginServer - master < Back


# Packages

-  package root
  Definition Classes
    root
-  package net
  Definition Classes
    root
-  package psforever
  Definition Classes
    net
-  package objects
  Definition Classes
    psforever
-  package serverobject
  Definition Classes
    objects
-  package terminals
  Definition Classes
    serverobject
-  package capture
  Definition Classes
    terminals
-  package implant
  Definition Classes
    terminals
- EquipmentTerminalDefinition
- GeneratorTerminalDefinition
- MatrixTerminalDefinition
- MedicalTerminalDefinition
- OrderTerminalDefinition
- ProximityDefinition
- ProximityTerminal
- ProximityTerminalControl
- ProximityTerminalDefinition
- ProximityUnit
- Terminal
- TerminalControl
- TerminalDefinition
- VehicleTerminalDefinition

o

net.psforever.objects.serverobject.terminals

# Terminal

###
Companion class Terminal

#### object Terminal

Source
  Terminal.scala

Linear Supertypes
AnyRef, Any

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. Terminal
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Type Members

1.  final case class BuyEquipment(item: Equipment) extends Exchange with Product with Serializable

   A single piece of `Equipment` has been selected and will be given to the `Player`.

   A single piece of `Equipment` has been selected and will be given to the `Player`. The `Player` must decide what to do with it once it is in their control. A result of a processed request.

   item

     the `Equipment` being given to the player

2.  final case class BuyExosuit(exosuit: types.ExoSuitType.Value, subtype: Int = 0) extends Exchange with Product with Serializable

   The `Player` exo-suit will be changed to the prescribed one.

   The `Player` exo-suit will be changed to the prescribed one. The subtype will be important if the user is swapping to an `ExoSuitType.MAX` exo-suit. A result of a processed request.

   exosuit

     the type of exo-suit

   subtype

     the exo-suit subtype, if any

3.  final case class BuyVehicle(vehicle: Vehicle, weapons: List[InventoryItem], inventory: List[InventoryItem]) extends Exchange with Product with Serializable

   Provide a vehicle that was constructed for the player.

   Provide a vehicle that was constructed for the player.

   vehicle

     the vehicle

   weapons

     the vehicle's mounted armament

   inventory

     the vehicle's trunk contents

4.  sealed trait Exchange extends AnyRef

   A basic `Trait` connecting all of the actionable `Terminal` response messages.

5.  final case class InfantryLoadout(exosuit: types.ExoSuitType.Value, subtype: Int = 0, holsters: List[InventoryItem], inventory: List[InventoryItem]) extends Exchange with Product with Serializable

   Recover a former exo-suit and `Equipment` configuration that the `Player` possessed.

   Recover a former exo-suit and `Equipment` configuration that the `Player` possessed. A result of a processed request.

   exosuit

     the type of exo-suit

   subtype

     the exo-suit subtype, if any

   holsters

     the contents of the `Player`'s holsters

   inventory

     the contents of the `Player`'s inventory

6.  final case class LearnCertification(cert: Certification) extends Exchange with Product with Serializable

   Provide the certification type unlocked by the player.

   Provide the certification type unlocked by the player.

   cert

     the certification unlocked

7.  final case class LearnImplant(implant: ImplantDefinition) extends Exchange with Product with Serializable

   Provide the implant type unlocked by the player.

   Provide the implant type unlocked by the player.

   implant

     the implant (definition) requested

8.  final case class NoDeal() extends Exchange with Product with Serializable

   No action will result from interacting with this `Terminal`.

   No action will result from interacting with this `Terminal`. A result of a processed request.

9.  final case class Request(player: Player, msg: ItemTransactionMessage) extends Product with Serializable

   Entry message into this `Terminal` that carries the request.

   Entry message into this `Terminal` that carries the request. Accessing an option in a `Terminal` normally always results in this message.

   player

     the player who sent this request message

   msg

     the original packet carrying the request

10.  final case class SellCertification(cert: Certification) extends Exchange with Product with Serializable

    Provide the certification type freed-up by the player.

    Provide the certification type freed-up by the player.

    cert

      the certification returned

11.  final case class SellEquipment() extends Exchange with Product with Serializable

    A roundabout message oft-times.

    A roundabout message oft-times. Most `Terminals` should always allow `Player`s to dispose of some piece of `Equipment`. A result of a processed request.

12.  final case class SellImplant(implant: ImplantDefinition) extends Exchange with Product with Serializable

    Provide the implant type freed-up by the player.

    Provide the implant type freed-up by the player.

    implant

      the implant (definition) returned

13.  final case class StartProximityEffect(terminal: Terminal with ProximityUnit) extends Exchange with Product with Serializable

    Start the special effects caused by a proximity-base service.

    Start the special effects caused by a proximity-base service.

    terminal

      the proximity-based unit

14.  final case class StopProximityEffect(terminal: Terminal with ProximityUnit) extends Exchange with Product with Serializable

    Stop the special effects caused by a proximity-base service.

    Stop the special effects caused by a proximity-base service.

    terminal

      the proximity-based unit

15.  final case class TerminalMessage(player: Player, msg: ItemTransactionMessage, response: Exchange) extends Product with Serializable

    Message that carries the result of the processed request message back to the original user (`player`).

    Message that carries the result of the processed request message back to the original user (`player`).

    player

      the player who sent this request message

    msg

      the original packet carrying the request

    response

      the result of the processed request

16.  final case class VehicleLoadout(vehicle_definition: VehicleDefinition, weapons: List[InventoryItem], inventory: List[InventoryItem]) extends Exchange with Product with Serializable

### 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 Constructor(pos: Vector3, tdef: TerminalDefinition)(id: Int, context: ActorContext): Terminal

   Instantiate and configure a `Terminal` object

   Instantiate and configure a `Terminal` object

   pos

     The location of the object

   tdef

     the `ObjectDefinition` that constructs this object and maintains some of its immutable fields

   id

     the unique id that will be assigned to this entity

   context

     a context to allow the object to properly set up `ActorSystem` functionality

   returns

     the `Terminal` object

5.  def apply(tdef: TerminalDefinition): Terminal

   Overloaded constructor.

   Overloaded constructor.

   tdef

     the `ObjectDefinition` that constructs this object and maintains some of its immutable fields

6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
8.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
9.  def equals(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef → Any
10.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
11.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
12.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
13.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
14.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
15.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
16.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
17.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
18.  def toString(): String
    Definition Classes
      AnyRef → Any
19.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
20.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
21.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Inherited from AnyRef

### Inherited from Any

### Ungrouped