Package org.skriptlang.skript.log.runtime

Class Frame

java.lang.Object

org.skriptlang.skript.log.runtime.Frame

public final class Frame
extends Object

Stores the accumulated runtime errors over a span of time, then prints them.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Frame.FrameLimit	Store limits for the number of issues a frame can print per frame.
static final record	Frame.FrameOutput	Stores outputs of a frame.

Constructor Summary

Constructors

Constructor	Description
Frame(Frame.FrameLimit limits)	Creates a blank frame with the given limits

Method Summary

Modifier and Type	Method	Description
boolean	add(@NotNull RuntimeError error)	Adds an error to this frame.
@NotNull Frame.FrameOutput	getFrameOutput()	Gets the output data for a frame.
void	nextFrame()	Advances the frame to the next frame, clearing all stored totals and decrementing timeout counters.

Methods inherited from class java.lang.Object

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

Constructor Details

Frame

public Frame(Frame.FrameLimit limits)

Creates a blank frame with the given limits

Parameters:

limits - The limits to use for when to skip or timeout.

Method Details

add

public boolean add(@NotNull
 @NotNull RuntimeError error)

Adds an error to this frame.

Parameters:

error - The error to add.

Returns:

Whether the error should be printed immediately.

nextFrame

public void nextFrame()

Advances the frame to the next frame, clearing all stored totals and decrementing timeout counters.

getFrameOutput

@Contract(" -> new")
@NotNull
public @NotNull Frame.FrameOutput getFrameOutput()

Gets the output data for a frame. Returned data contains unmodifiable views of frame data, which is not guaranteed to stay valid.

Returns:

The current output data of this frame.