Package net.minecraftforge.client.event

Class ScreenshotEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.client.event.ScreenshotEvent

public class ScreenshotEvent
extends net.minecraftforge.eventbus.api.Event

This event is fired before and after a screenshot is taken This event is fired on the MinecraftForge.EVENT_BUS This event is Cancelable screenshotFile contains the file the screenshot will be/was saved to image contains the NativeImage that will be saved resultMessage contains the ITextComponent to be returned. If null, the default vanilla message will be used instead

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event

net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
static final ITextComponent	DEFAULT_CANCEL_REASON
private NativeImage	image
private ITextComponent	resultMessage
private File	screenshotFile

Constructor Summary

Constructors

Constructor	Description
ScreenshotEvent(NativeImage image, File screenshotFile)

Method Summary

Modifier and Type	Method	Description
ITextComponent	getCancelMessage()
NativeImage	getImage()
ITextComponent	getResultMessage()
File	getScreenshotFile()
void	setResultMessage(ITextComponent resultMessage)
void	setScreenshotFile(File screenshotFile)

Methods inherited from class net.minecraftforge.eventbus.api.Event

getListenerList, getParentListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult, setup

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CANCEL_REASON

public static final ITextComponent DEFAULT_CANCEL_REASON

image

private NativeImage image

screenshotFile

private File screenshotFile

resultMessage

private ITextComponent resultMessage

Constructor Details

ScreenshotEvent

public ScreenshotEvent(NativeImage image,
 File screenshotFile)

Method Details

getImage

public NativeImage getImage()

getScreenshotFile

public File getScreenshotFile()

setScreenshotFile

public void setScreenshotFile(File screenshotFile)

getResultMessage

public ITextComponent getResultMessage()

setResultMessage

public void setResultMessage(ITextComponent resultMessage)

getCancelMessage

public ITextComponent getCancelMessage()