final case class CollisionReason(velocity: Vector3, fall: Float, damageModel: DamageAndResistance) extends CausedByColliding with Product with Serializable

A wrapper for a "damage source" in damage calculations that explains a collision.

velocity

how fast the target is moving prior to the collision

fall

ongoing vertical displacement since before the collision

damageModel

the functionality that is necessary for interaction of a vital game object with the rest of the hostile game world

Source
CollisionReason.scala
Linear Supertypes
Serializable, Product, Equals, CausedByColliding, DamageReason, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CollisionReason
  2. Serializable
  3. Product
  4. Equals
  5. CausedByColliding
  6. DamageReason
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CollisionReason(velocity: Vector3, fall: Float, damageModel: DamageAndResistance)

    velocity

    how fast the target is moving prior to the collision

    fall

    ongoing vertical displacement since before the collision

    damageModel

    the functionality that is necessary for interaction of a vital game object with the rest of the hostile game world

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 adversary: Option[SourceEntry]

    The person to be blamed for this.

    The person to be blamed for this.

    Definition Classes
    CollisionReasonDamageReason
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def attribution: Int

    Specifics about the method of damage, expected as an object class's unique identifier.

    Specifics about the method of damage, expected as an object class's unique identifier.

    returns

    defaults to 0

    Definition Classes
    DamageReason
  7. def calculate(data: DamageInteraction, dtype: base.DamageType.Value): Output

    Perform the modified damage value and the basic resistance value allocations to be used against a given valid target.

    Perform the modified damage value and the basic resistance value allocations to be used against a given valid target.

    data

    the damaging interaction to be evaluated

    dtype

    custom damage property for resistance allocation

    returns

    an application function that takes a target and returns a result

    Definition Classes
    DamageReason
  8. def calculate(data: DamageInteraction): Output

    Perform the modified damage value and the basic resistance value allocations to be used against a given valid target.

    Perform the modified damage value and the basic resistance value allocations to be used against a given valid target.

    data

    the damaging interaction to be evaluated

    returns

    an application function that takes a target and returns a result

    Definition Classes
    DamageReason
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. val damageModel: DamageAndResistance

    The functionality that is necessary for interaction of a vital game object with the rest of the hostile game world.

    The functionality that is necessary for interaction of a vital game object with the rest of the hostile game world.

    Definition Classes
    CollisionReasonDamageReason
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. val fall: Float
    Definition Classes
    CollisionReasonCausedByColliding
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. def resolution: base.DamageResolution.Value

    An indication about how the damage was or will be processed.

    An indication about how the damage was or will be processed.

    Definition Classes
    CausedByCollidingDamageReason
  21. def same(test: DamageReason): Boolean

    Determine whether two damage sources are equivalent.

    Determine whether two damage sources are equivalent.

    test

    the damage source to compare against

    returns

    true, if equivalent; false, otherwise

    Definition Classes
    CollisionReasonDamageReason
  22. def source: DamageProperties

    A direct connection to the damage information, numbers and properties.

    A direct connection to the damage information, numbers and properties.

    Definition Classes
    CausedByCollidingDamageReason
  23. def staticModifiers: List[DamageProfile]

    Modifiers to the raw/modified damage value that are additive in nature.

    Modifiers to the raw/modified damage value that are additive in nature. These modifiers use a selector function to extract the damage value from the profile, a process required to acquire the raw damage value, outlined elsewhere.

    returns

    a list of modifications to apply (in order)

    Definition Classes
    DamageReason
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def unstructuredModifiers: List[Mod]

    Modifiers to the raw/modified damage value that are multiplicative or provide disjoint modification.

    Modifiers to the raw/modified damage value that are multiplicative or provide disjoint modification.

    returns

    a list of modifications to apply (in order)

    Definition Classes
    CollisionReasonDamageReason
  26. val velocity: Vector3
    Definition Classes
    CollisionReasonCausedByColliding
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CausedByColliding

Inherited from DamageReason

Inherited from AnyRef

Inherited from Any

Ungrouped