Struct ScreenshotEvent 

pub struct ScreenshotEvent<'a> {
    pub image: &'a mut ScreenshotImage,
    pub file_name: &'a mut String,
    pub message: &'a mut Option<Text>,
    pub cancelled: bool,
}

What Hooks::screenshot is told. Each field is that hook’s argument of the same name, described in the hook’s doc.

Fields

image: &'a mut ScreenshotImage

file_name: &'a mut String

message: &'a mut Option<Text>

cancelled: bool

Whether the event is cancelled: by the game or an earlier listener, or by this one setting it. Only a listener that receives cancelled events (#[listener(receive_cancelled)]) sees true, and setting it back to false lets the game’s behaviour run.