Fly With Lua NG En Manual

FlyWithLua V2.7 NG Reference Manual

William Good

October 09, 2018

This manual is trying to document the added features that

FlyWithLua NG provides and is meant to be used with the

original manual.

Two new features that were added is floating windows and

support for Imgui. Floating windows allow you to create a

window that can be used in 2d or VR that supports OpenGL

are prefaced with “imgui_”.

Reference

Predefined variables

SYSTEM_DIRECTORY

Full path to the X-Plane install directory with trailing slash.

INTERNALS_DIRECTORY

Full path to the FlyWithLua Internals directory with trailing

slash.

MODULES_DIRECTORY

Full path to the FlyWithLua Modules directory with trailing

scalable pixes. If the UI scale is set to 100% in the settings, a boxel equals

a pixel. However, if the user sets the UI scale to more than 100%, a boxel will

be scaled to span multiple pixels.

The third parameter specifies the window decoration. The following decorations are possible:

0: "X-Plane will draw no decoration for your window, and apply no automatic click handlers.

The window will not stop click from passing through its bounds. This is suitable for

"windows" which request, say, the full screen bounds, then only draw in a small portion

of the available area."

1: "The default decoration for "native" windows, like the map. Provides a solid background,

as well as click handlers for resizing and dragging the window."

The return value is a handle to the window that can be used to configure additional things.

This function sets the title of the window if it has a decoration.

float_wnd_set_title(demo_floating_wnd, "floating window

The first parameter must be a handle to a window previously created with float_wnd_create and the

second parameter is the title of the window.

This function sets the initial position of the window.

float_wnd_set_position(demo_floating_wnd, 775, 650)

The first parameter must be a handle to a window previously created with float_wnd_create and the

second and third parameters set the initial position of the window.

The first parameter must be a handle to a window previously created with float_wnd_create and the

second parameter set the name of the onclick function.

This function sets the name of the onclose function.

float_wnd_set_onclose(demo_floating_wnd,

"on_close_floating_window")

The first parameter must be a handle to a window previously created with float_wnd_create and the

second parameter set the name of the onclose function.

x and y are the origin of the window, i.e. the lower left

x increases to the right, y increases to the top

function on_click_floating_window(demo_floating_wnd, x3, y3)

When on_close it called, it is illegal to do anything with the wnd variable.

It is also not allowed to create new windows in on_close!

"windows" which request, say, the full screen bounds, then only draw in a small portion

of the available area."

1: "The default decoration for "native" windows, like the map. Provides a solid background,

as well as click handlers for resizing and dragging the window."

2: "X-Plane will draw no decoration for your window, nor will it provide resize handlers for

your window edges, but it will stop clicks from passing through your windows bounds."

3: "Like 2, but with resizing; X-Plane will draw no decoration for your window, but it will stop

clicks from passing through your windows bounds, and provide automatic mouse

handlers for resizing."

The last parameter configures whether you want to use imgui for the floating window.

This function sets the title of the window if it has a decoration.

float_wnd_set_position(demo_wnd, 775, 650)

second and third parameters set the initial position of the window.

If the window has a decoration with a close button (like decoration

1), you might need a way to know when the users closes the window.

This function can be used to setup a function to be called when the

user closes the window.

float_wnd_set_onclose(demo_wnd, "closed_demo")

second parameter must be the name of a function. Note that unlike other function in FlyWithLua, you

can only pass the name of a function here, not an arbitrary lua string. This function will be called

when the user closes the window. After the window is closed, its builder function will not be called

again and it is illegal to use the window handle variable returned by float_wnd_create, e.g. it is illegal

angle = 0

text = ""

function build_demo(wnd, x, y)

This function is called for every frame. Use this function to create your GUI. The first parameter (wnd)

is the handle of the window. It is the same handle as the one returned by float_wnd_create. It is

required if you have multiple windows that use the same builder function so you know which of these

windows is currently being built. The x and y parameters are the current position of the window in

OpenGL coordinates, i.e. the position of the lower left corner in global screen coordinates. These

coordinates are only needed for using the graphics module on top of the imgui GUI. If you only use

imgui, these coordinates are not required because imgui has its own coordinate system inside the

window.

function closed_demo(wnd)

This function is called when the user closes the window. Drawing or calling imgui functions is not

allowed in this function as the window is already destroyed.