Module event

Event Handlers.

Scripts can repsond to events by setting the functions in the 'event' table. Event handler functions can take one integer parameter, and must return a boolean that specifies whether or not the backend should continue executing event handlers for this particular event.

Event handlers will not run if there's already a script or another event handler actively executing at the same time.

Usage:

    
     event.keypress = function(key)
    
     print("You pressed a key: "..key)
    
     return false
    
     end
    

Info:

  • Copyright: 2014
  • License: GPL
  • Author: Magic Lantern Team

Functions

pre_shoot (arg) Called before a picture is taken
post_shoot (arg) Called after a picture is taken
shoot_task (arg) Called periodicaly from shoot_task
seconds_clock (arg) Called each second
keypress (key) Called when a key is pressed
custom_picture_taking (arg) Special types of picture taking (e.g.
intervalometer (interval_count) Called after a picture is taken with the intervalometer
config_save (arg) Called when configs are being saved; save any config data for your script here


Functions

pre_shoot (arg)
Called before a picture is taken

Parameters:

  • arg unused

Returns:

    bool whether or not to continue executing CBRs for this event
post_shoot (arg)
Called after a picture is taken

Parameters:

  • arg unused

Returns:

    bool whether or not to continue executing CBRs for this event
shoot_task (arg)
Called periodicaly from shoot_task

Parameters:

  • arg unused

Returns:

    bool whether or not to continue executing CBRs for this event
seconds_clock (arg)
Called each second

Parameters:

  • arg unused

Returns:

    bool whether or not to continue executing CBRs for this event
keypress (key)
Called when a key is pressed

Parameters:

Returns:

    bool whether or not to continue executing CBRs for this event
custom_picture_taking (arg)
Special types of picture taking (e.g. silent pics); so intervalometer and other photo taking routines should use that instead of regular pics

Parameters:

  • arg unused

Returns:

    bool whether or not to continue executing CBRs for this event
intervalometer (interval_count)
Called after a picture is taken with the intervalometer

Parameters:

  • interval_count int the current interval count

Returns:

    bool whether or not to continue executing CBRs for this event
config_save (arg)
Called when configs are being saved; save any config data for your script here

Parameters:

  • arg unused

Returns:

    bool whether or not to continue executing CBRs for this event
generated by LDoc 1.4.3 Last updated 2016-04-23 15:53:20