Free Hero Mesh

Artifact ID:	45efdeb1c66cc18886f75ac373aa33dec345c997
Page Name:	SQL functions
Date:	2018-06-10 15:52:56
Original User:	zzo38
Parent:	6923f03d05639f30bba0948acf1d56f4d94651b8 (diff)
Next	d879781b149de39ecf6275dca7c9abfaf88b3868

This document is a list of the available SQL functions that you can use in the customization of Free Hero Mesh. In addition to the ones listed here, you can also use the core functions, date/time functions, and aggregate functions, of SQLite, as well as any functions defined by extensions. See also: SQL tables.

(Note: This is only a draft and is likely to change in future.)

Asterisks in the headings indicate aggregate functions.

BASENAME()

Returns the base name, which is a copy of the first command-line argument (other than switches).

LEVEL()

Returns the one-based order number of the current level.

LEVEL_CACHEID()

Returns the ID number of the active level file in the user cache table.

LEVEL_ID()

Returns the ID number of the current level.

MODSTATE()

Get the current keyboard modifiers state. It is the sum of the following:

• 0x0001: Left shift
• 0x0002: Right shift
• 0x0040: Left control
• 0x0080: Right control
• 0x0100: Left alt
• 0x0200: Right alt
• 0x0400: Left meta
• 0x0800: Right meta
• 0x1000: Num lock
• 0x2000: Caps lock
• 0x4000: Mode

MOVENUMBER()

Tells you how many moves have been played so far since it has been reset.

PICTURE_SIZE()

Tell you the picture size.

RESOURCE(...)

Given a list of strings, find the matching resource from the .heromeshrc file and command-line arguments. Result is null if there is no such resource value.

SIGN_EXTEND(num)

Sign-extend a 32-bit integer to 64-bits. The 32-bit user variables in Free Hero Mesh might or might not be signed, so when accessing them in SQL (which uses 64-bit numbers) you must use this if you want to treat it as a signed number.

SOLUTION_CACHEID()

Returns the ID number of the active level file in the user cache table.

SOLUTION_REPLAY()

Returns 1 if replaying the solution or 0 for the normal game.