Package net.thewinnt.cutscenes.effect.type

Class AbstractOverlayEffect<C,O extends Overlay>

java.lang.Object

net.thewinnt.cutscenes.effect.CutsceneEffect<C>

net.thewinnt.cutscenes.effect.type.AbstractOverlayEffect<C,O>

Type Parameters:

C - the configuration type

O - the overlay type

Direct Known Subclasses:

AppearingTextEffect, BlitEffect, RectangleEffect, TriangleStripEffect

public abstract class AbstractOverlayEffect<C,O extends Overlay>
extends CutsceneEffect<C>

A base class for effects using overlays

Field Summary

Fields

Modifier and Type	Field	Description
protected O	overlay
protected TimeProvider	time

Fields inherited from class net.thewinnt.cutscenes.effect.CutsceneEffect

config, endTime, startTime

Constructor Summary

Constructors

Constructor	Description
AbstractOverlayEffect(double startTime, double endTime, C config)

Method Summary

Modifier and Type	Method	Description
protected abstract O	createOverlay(C config)
void	onEnd(net.minecraft.client.multiplayer.ClientLevel level, CutsceneType cutscene)	Called after the last tick of the effect
void	onFrame(double time, net.minecraft.client.multiplayer.ClientLevel level, CutsceneType cutscene)	Called every frame that the cutscene is rendered
void	onStart(net.minecraft.client.multiplayer.ClientLevel level, CutsceneType cutscene)	Called before the first tick of the effect

Methods inherited from class net.thewinnt.cutscenes.effect.CutsceneEffect

fromJSON, fromNetwork, getSerializer, toNetwork

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

overlay

protected O extends Overlay overlay

time

protected TimeProvider time

Constructor Details

AbstractOverlayEffect

public AbstractOverlayEffect(double startTime,
 double endTime,
 C config)

Method Details

createOverlay

protected abstract O createOverlay(C config)

onStart

public void onStart(net.minecraft.client.multiplayer.ClientLevel level,
 CutsceneType cutscene)

Description copied from class: CutsceneEffect

Called before the first tick of the effect

Specified by:

onStart in class CutsceneEffect<C>

Parameters:

cutscene - the cutscene type that this effect is used from

onFrame

public void onFrame(double time,
 net.minecraft.client.multiplayer.ClientLevel level,
 CutsceneType cutscene)

Description copied from class: CutsceneEffect

Called every frame that the cutscene is rendered

Specified by:

onFrame in class CutsceneEffect<C>

Parameters:

time - the time in ticks since the effect started, in range [0; endTime - startTime]

level - the client level that the effect is running in

cutscene - the cutscene type that this effect is used from

onEnd

public void onEnd(net.minecraft.client.multiplayer.ClientLevel level,
 CutsceneType cutscene)

Description copied from class: CutsceneEffect

Called after the last tick of the effect

Specified by:

onEnd in class CutsceneEffect<C>

Parameters:

cutscene - the cutscene type that this effect is used from