StdLib.Event.Surface

Surface storage creation. <p>All surfaces will be added to the storage.surfaces table. <p>This modules events should be registered after any other Init functions but before any scripts needing storage.surfaces. <p>This modules can register the following events:

@usage

Methods8

function Surface.additional_data(...) -> StdLib.Event.Surface

function Surface.remove(event: table) -> nil

Remove data for a surface when it is deleted.

Parameters

eventtable: event table containing the surface index

Returns

nil

function Surface.rename(event) -> nil

function Surface.import(event) -> nil

function Surface.init(event: nil | table | string | number | LuaSurface[opt], overwrite: nil | boolean) -> any

Init or re-init the surfaces. Passing a nil event will iterate all existing surfaces.

Parameters

eventnil | table | string | number | LuaSurface[opt]
overwritenil | boolean: [opt=false] the surface data

Returns

any

function Surface.dump_data() -> nil

function Surface.register_init() -> StdLib.Event.Surface

function Surface.register_events(do_on_init) -> StdLib.Event.Surface

Fields2

Surface.__class: string = "Surface"

Surface._new_surface_data: table