Class/Object

net.psforever.objects

Tool

Related Docs: object Tool | package objects

Permalink

class Tool extends Equipment with FireModeSwitch[FireModeDefinition]

A type of Equipment that can be wielded and loaded with certain other game elements.

"Tool" is a very mechanical name while this class is intended for various weapons and support items. The primary trait of a Tool is that it has something that counts as an "ammunition," depleted as the Tool is used, replaceable as long as one has an appropriate type of AmmoBox object. (The former is always called "consuming;" the latter, "reloading.") Some weapons Chainblade have ammunition but do not consume it.

Source
Tool.scala
Linear Supertypes
FireModeSwitch[FireModeDefinition], Equipment, FactionAffinity, PlanetSideGameObject, WorldEntity, IdentifiableEntity, Identifiable, AnyRef, Any
Known Subclasses
TurretWeapon
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Tool
  2. FireModeSwitch
  3. Equipment
  4. FactionAffinity
  5. PlanetSideGameObject
  6. WorldEntity
  7. IdentifiableEntity
  8. Identifiable
  9. AnyRef
  10. 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 Tool(toolDef: ToolDefinition)

    Permalink

    toolDef

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from Tool to ArrowAssoc[Tool] 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 AmmoSlot: FireModeSlot

    Permalink

  7. def AmmoSlots: List[FireModeSlot]

    Permalink

  8. def AmmoType: equipment.Ammo.Value

    Permalink

  9. def AmmoTypeIndex: Int

    Permalink

  10. def AmmoTypeIndex_=(index: Int): Int

    Permalink

  11. def Definition: ToolDefinition

    Permalink
    Definition Classes
    Tool → Equipment → PlanetSideGameObject

  12. def Discharge: Int

    Permalink

  13. def Entity: WorldEntity

    Permalink
    Definition Classes
    PlanetSideGameObject

  14. def Entity_=(newEntity: WorldEntity): Unit

    Permalink
    Definition Classes
    PlanetSideGameObject

  15. def Faction: types.PlanetSideEmpire.Value

    Permalink
    Definition Classes
    Equipment → FactionAffinity

  16. def Faction_=(fact: types.PlanetSideEmpire.Value): types.PlanetSideEmpire.Value

    Permalink
    Definition Classes
    Equipment → FactionAffinity

  17. def FireMode: FireModeDefinition

    Permalink
    Definition Classes
    Tool → FireModeSwitch

  18. def FireModeIndex: Int

    Permalink
    Definition Classes
    Tool → FireModeSwitch

  19. def FireModeIndex_=(index: Int): Int

    Permalink
    Definition Classes
    Tool → FireModeSwitch

  20. def GUID: PlanetSideGUID

    Permalink
    Definition Classes
    IdentifiableEntity → Identifiable

  21. def GUID_=(guid: PlanetSideGUID): PlanetSideGUID

    Permalink
    Definition Classes
    IdentifiableEntity → Identifiable

  22. def HasGUID: Boolean

    Permalink
    Definition Classes
    IdentifiableEntity

  23. def Invalidate(): Unit

    Permalink
    Definition Classes
    IdentifiableEntity

  24. def Magazine: Int

    Permalink

  25. def Magazine_=(mag: Int): Int

    Permalink

  26. def MaxAmmoSlot: Int

    Permalink

  27. def MaxMagazine: Int

    Permalink

  28. def NextAmmoType: equipment.Ammo.Value

    Permalink

  29. def NextFireMode: FireModeDefinition

    Permalink
    Definition Classes
    Tool → FireModeSwitch

  30. def Orientation: Vector3

    Permalink
    Definition Classes
    PlanetSideGameObject → WorldEntity

  31. def Orientation_=(vec: Vector3): Vector3

    Permalink
    Definition Classes
    PlanetSideGameObject → WorldEntity

  32. def Position: Vector3

    Permalink
    Definition Classes
    PlanetSideGameObject → WorldEntity

  33. def Position_=(vec: Vector3): Vector3

    Permalink
    Definition Classes
    PlanetSideGameObject → WorldEntity

  34. def Projectile: ProjectileDefinition

    Permalink

  35. def ProjectileType: ballistics.Projectiles.Value

    Permalink

  36. def Size: equipment.EquipmentSize.Value

    Permalink
    Definition Classes
    Equipment

  37. def Tile: InventoryTile

    Permalink
    Definition Classes
    Equipment

  38. def ToFireMode: Int

    Permalink

  39. def ToFireMode_=(index: Int): FireModeDefinition

    Permalink

  40. def Velocity: Option[Vector3]

    Permalink
    Definition Classes
    PlanetSideGameObject → WorldEntity

  41. def Velocity_=(vec: Option[Vector3]): Option[Vector3]

    Permalink
    Definition Classes
    PlanetSideGameObject → WorldEntity

  42. def Velocity_=(vec: Vector3): Option[Vector3]

    Permalink
    Definition Classes
    WorldEntity

  43. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  44. def clone(): AnyRef

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

  45. def ensuring(cond: (Tool) ⇒ Boolean, msg: ⇒ Any): Tool

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

  46. def ensuring(cond: (Tool) ⇒ Boolean): Tool

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

  47. def ensuring(cond: Boolean, msg: ⇒ Any): Tool

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

  48. def ensuring(cond: Boolean): Tool

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

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

    Permalink
    Definition Classes
    AnyRef

  50. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  51. def finalize(): Unit

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

  52. def formatted(fmtstr: String): String

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  54. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  55. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  56. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  57. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  58. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  60. def toString(): String

    Permalink
    Definition Classes
    Tool → Equipment → AnyRef → Any

  61. final def wait(): Unit

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

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

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

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

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

  64. def →[B](y: B): (Tool, B)

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

Inherited from FireModeSwitch[FireModeDefinition]

Inherited from Equipment

Inherited from FactionAffinity

Inherited from PlanetSideGameObject

Inherited from WorldEntity

Inherited from IdentifiableEntity

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped