CPFadeShimmerLogoScene

org.cosplay.prefabs.scenes.CPFadeShimmerLogoScene
class CPFadeShimmerLogoScene(id: String, dim: Option[CPDim], bgPx: CPPixel, colors: Seq[CPColor], nextSc: String, fadeInMs: Long, fadeOutMs: Long, shimmerKeyFrame: Int) extends CPScene

A scene that displays CosPlay logo with shimmering colors for a few seconds using fade in and fade out shaders.

Value parameters

bgPx

Background pixel of the scene.

colors

Logo will shimmer with these colors. Typically, these should be the game's primary colors.

dim

Optional dimension of the scene. Note that if dimension is None then scene will adapt to the terminal dimension on each frame. That means that the scene's canvas on which all scene objects are rendered can change its size from frame to frame. In such case, make sure that all scene objects take this into account in their rendering routines.

fadeInMs

Optional fade in duration in milliseconds. Default value is 2000.

fadeOutMs

Optional fade out duration in milliseconds. Default value is 1000.

id

ID of the scene.

nextSc

ID of the next scene to switch to once this scene has finished its shimmering logo effect.

shimmerKeyFrame

Optional shimmer shader keyframe. Default value is 2.

Attributes

See also
Source
CPFadeShimmerLogoScene.scala
Graph
Supertypes
class CPScene
trait CPLifecycle
class CPGameObject
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

override def equals(obj: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
CPGameObject -> Any
Inherited from:
CPGameObject
Source
CPGameObject.scala
inline def getBgColor: CPColor

Background color of the background pixel.

Background color of the background pixel.

Attributes

Inherited from:
CPScene
Source
CPScene.scala
inline def getBgPixel: CPPixel

Gets background pixel of this scene. Note that background pixel always has its background color defined.

Gets background pixel of this scene. Note that background pixel always has its background color defined.

Attributes

Inherited from:
CPScene
Source
CPScene.scala
inline def getCamera: CPCamera

Gets mutable camera panning descriptor associated with this scene. By default, the camera panning is not attached to any scene object. You need to configure the returning camera descriptor if you need camera tracking.

Gets mutable camera panning descriptor associated with this scene. By default, the camera panning is not attached to any scene object. You need to configure the returning camera descriptor if you need camera tracking.

Attributes

Inherited from:
CPScene
Source
CPScene.scala
inline def getDim: Option[CPDim]

Gets this scene dimension.

Gets this scene dimension.

Attributes

Inherited from:
CPScene
Source
CPScene.scala
def getId: String

Gets unique ID of this game object.

Gets unique ID of this game object.

Attributes

Inherited from:
CPGameObject
Source
CPGameObject.scala
final def getState: State

Gets current lifecycle state.

Gets current lifecycle state.

Attributes

Inherited from:
CPLifecycle
Source
CPLifecycle.scala
def getTags: Set[String]

Gets optional set of organizational tags. Note that by default the set of tags is empty.

Gets optional set of organizational tags. Note that by default the set of tags is empty.

Attributes

See also
Inherited from:
CPGameObject
Source
CPGameObject.scala
def onActivate(): Unit

Callback on lifecycle object activation. Default implementation is no-op.

Callback on lifecycle object activation. Default implementation is no-op.

Attributes

See also

CPLifecycle.State.LF_ACTIVE

Inherited from:
CPLifecycle
Source
CPLifecycle.scala
def onDeactivate(): Unit

Callback on lifecycle object deactivation. Default implementation is no-op.

Callback on lifecycle object deactivation. Default implementation is no-op.

Attributes

See also

CPLifecycle.State.LF_INACTIVE

Inherited from:
CPLifecycle
Source
CPLifecycle.scala
def onStart(): Unit

Callback on lifecycle object start. Default implementation is no-op.

Callback on lifecycle object start. Default implementation is no-op.

Attributes

See also

CPLifecycle.State.LF_STARTED

Inherited from:
CPLifecycle
Source
CPLifecycle.scala
def onStop(): Unit

Callback on lifecycle object stop. Default implementation is no-op.

Callback on lifecycle object stop. Default implementation is no-op.

Attributes

See also

CPLifecycle.State.LF_STOPPED

Inherited from:
CPLifecycle
Source
CPLifecycle.scala

Concrete fields

val skipFn: (CPZPixel, Int, Int) => Boolean

Attributes

Source
CPFadeShimmerLogoScene.scala