game.take_screenshot additions.

[credomane]

Current game.take_screenshot options table is

Code: Select all

    player :: LuaPlayer (optional)
    by_player :: LuaPlayer (optional)
    position :: Position (optional)
    resolution :: Position (optional)
    zoom :: double (optional)
    path :: string (optional): Path to save the screenshot in
    show_gui :: boolean (optional): Include game GUI in the screenshot?
    show_entity_info :: boolean (optional): Include entity info (alt-mode)?

My proposed update is to add surface and brightness fields to the options table

Code: Select all

    player :: LuaPlayer (optional)
    by_player :: LuaPlayer (optional)
    position :: Position (optional)
    surface :: LuaSurface (optional)
    resolution :: Position (optional)
    zoom :: double (optional)
    path :: string (optional): Path to save the screenshot in
    show_gui :: boolean (optional): Include game GUI in the screenshot?
    show_entity_info :: boolean (optional): Include entity info (alt-mode)?
    brightness :: double (optional) :: Take screenshot at specified brightness 14% is in-game night and 100% is normal daylight.

Surface is needed to make sure the screenshot is take of the right surface and not the player's current surface. This is especially important for mods that make time-lapses or create a map of your world. Now that mods like factorissimo creating multiple surfaces the chance of the screenshot being of the completely wrong surface than intended increases rapidly.

Brightness is needed to allow for screenshots to always be taken at a specific brightness level regardless of what the surface brightness currently is. Removes the need to perform ugly "hacks" to simulate this. The train cameras already seem to do this so I, naively, assume giving this power to take_screenshot is quick-n-easy.

[credomane]

I know this is an old post but I figured I would revive it rather than duplicate it.

Would it be possible to add these additions to the screenshot function? The camera GUI element can already specify what surface it wants. I figure adding that to the screenshot function shouldn't be "too much" work and highly convenient for mods than make use of screenshots.

Adding in the ability to say what the brightness is in the screenshot would remove the need for ugly work-arounds.

[Bilka]

Surface and daytime parameters were added to take_screenshot at some point. I will take the liberty to assume that daytime covers your usecase for brightness, since you mention the day and night brightness values.