Gkinterface

From Vendetta Lua
Revision as of 18:34, 3 February 2008 by Greshnatok (Talk | contribs)

Jump to: navigation, search

Interface related functions.

Mouse related Functions

These come in pairs of Get/Set functions:

GetMouseLookMode/SetMouseLookMode

These relate to the mouselook mode. "True" with these refers to mouselook being on, false to mouselook being disabled.

gkinterface.SetMouseLookMode(true) -- enables mouselook mode
gkinterface.GetMouseLookMode() -- would return "true" now
gkinterface.SetMouseLookMode(false) -- disables mouselook mode
gkinterface.GetMouseLookMode() -- would return "false" now


GetMouseOptions

GetMousePosition

GetMouseSensitivity

SetMouseCursor

SetMouseCursorIndexImage

SetMouseHotspot

SetMouseLookMode

SetMouseOptions

SetMouseSensitivity

Uncategorized Functions

AddDirectionalLight

BindCommand

BindJoystickCommand

CaptureMouse

Draw3DScene

EvictTextures

GetAudioDrivers

GetAudioOptions

GetBindsForCommand

GetCommandForKeyboardBind

GetCurrentAudioDriverName

GetCurrentVideoDriverName

GetGameOptions

GetGraphicsOptions

GetInputCodeByName

GetNameForInputCode

GetVideoDrivers

GetVideoOptions

GetXResolution

Definition: gkinterface.GetXResolution -> int width

Description Returns the width of the current game resolution

Arguments None

Returns An int containing the current game screen width (e.g. 800)

GetYResolution

Definition: gkinterface.GetYResolution -> int width

Description Returns the height of the current game resolution

Arguments None

Returns An int containing the current game screen height (e.g. 600)

GKLoadCommands

GKPoll

GKProcessCommand

GKRenderFrame

GKUpdateFrame

HideMouse

InitializeLevelGfx

IsAltKeyDown

Definition: gkinterface.IsAltKeyDown() -> bool pressed

Description Test if the Alt key is currently pressed.

Arguments None

Returns True if the either of the alt keys is currently pressed, false otherwise.

IsCtrlKeyDown

Definition: gkinterface.IsCtrlKeyDown() -> bool pressed

Description Test if the Ctrl key is currently pressed.

Arguments None

Returns True if the either of the ctrl keys is currently pressed, false otherwise.

IsShiftKeyDown

Definition: gkinterface.IsShiftKeyDown() -> bool pressed

Description Test if the shift key is currently pressed.

Arguments None

Returns True if the either of the shift keys is currently pressed, false otherwise.

LoadDefaults

QueryAudio

QueryVideo

SetAudioDriver

SetAudioOptions

SetCamera

SetFOV

Definition: gkinterface.SetFOV(int angle) -> nil

Description Sets the Field of View angle in degrees (from 1 to 179). Note that this value is reset each time the player warps to another sector.

Arguments int angle -> the new angle for the field of view.

Returns nil

SetGameOptions

SetGraphicsOptions

SetVideoDriver

SetVideoOptions

SetVisualQuality

ShowMouse

UnbindCommand

UninitializeLevelGfx