event.commandLineArgs

Overview

An array of strings representing command line arguments that were given to subsequent launches of a single-instance-only Win32 desktop app that is already running. This property only exists when event.type is "applicationOpen".

If a Win32 desktop app is set up to be single-instance-only in its build.settings file (reference), subsequent launches of the app will bring the first instance’s window to the front of the desktop instead. If any command line arguments were provided to the second instance, its arguments are delivered to the first instance via an "applicationOpen" typed system event via this property.

Gotchas

An "applicationOpen" typed system event will not be dispatched:

• If the Win32 desktop app’s singleInstance build setting is set to false (reference).
• If attempting to launch a second Win32 desktop app instance without any command line arguments. In this case, the window is simply brought to the front of the desktop.
• For the first launch of the Win32 desktop app. Command line arguments will be provided to the main.lua file’s ... launch arguments via an args property.