Useful LunaLua Documentation Quick Links
Posted: Mon Mar 14, 2016 8:05 pm
These are some direct links to important and/or frequently used pages in the LunaLua documentation, to help avoid searching through the surprisingly large PGE Wiki:
Global functions:
http://wohlsoft.ru/pgewiki/LunaLua_global_functions
All of your general, graphics, static item, text, and miscellaneous functions. Not to be confused with events.
Global sound and music functions:
http://wohlsoft.ru/pgewiki/LunaLua_glob ... _functions
All of your functions to do with music and sound effects. Not to be confused with events.
Events:
http://wohlsoft.ru/pgewiki/LunaLua_events
Both your overworld and level events. Always preceeded by "function". They trigger code written inside them whenever a certain time or other criteria is met.
API functions and events:
http://wohlsoft.ru/pgewiki/LunaLua_global_API_functions
An API, which is placed in Lua Scripts Lib, has certain characteristics and events that make it an API. These items are required for it to function. Refer to barebones.lua for more help info on API format.
Hardcoded image list:
http://wohlsoft.ru/pgewiki/Hardcoded_Im ... MBX_Engine
Certain SMBX graphics require Lua to be used, since they are built in farther than the normal graphics folder. Replacements of hardcoded images can be added to the custom graphics folder of a level or an episode to be used, but they must have the exact same name and dimensions (size).
Sound effects list:
http://wohlsoft.ru/pgewiki/SFX_list_(SMBX64)
The sound effects in the SMBX sounds folder are not in order. Use this list to find their IDs, which is needed for changing sounds in .ini's and for multiple sound effect functions.
Player offsets:
http://wohlsoft.ru/pgewiki/SMBX_Player_Offsets
The values held in memory to do with the player's state, actions, etc.
NPC offsets:
http://wohlsoft.ru/pgewiki/SMBX_NPC_Offsets
The values held in memory to do with the state of NPCs, their actions, etc.
NPC AIs:
http://wohlsoft.ru/pgewiki/SMBX_NPC_AI
Descriptors of the default AI of all NPCs.
NPC functions:
http://wohlsoft.ru/pgewiki/NPC_(class)
Mainly functions and field values to do with NPCs. Not to be confused with events.
Player functions:
http://wohlsoft.ru/pgewiki/Player_(class)
Mainly functions and field values to do with the player(s). Not to be confused with events.
Section functions:
http://wohlsoft.ru/pgewiki/Section_(class)
Mainly functions and field values to do with the section(s). Not to be confused with events.
Block functions:
http://wohlsoft.ru/pgewiki/Block_(class)
Mainly functions and field values to do with blocks. Not to be confused with events.
Animation functions:
http://wohlsoft.ru/pgewiki/Animation_(class)
Mainly functions and field values to do with graphical animations. Not to be confused with events.
Layer functions:
http://wohlsoft.ru/pgewiki/Layer_(class)
Mainly functions and field values to do with layers. Not to be confused with events.
Data functions:
http://wohlsoft.ru/pgewiki/Data_(class)
The functions, constructors, field values, and enums to do with saving data. Not to be confused with events.
Event functions:
http://wohlsoft.ru/pgewiki/Event_(class)
Mainly functions and field values to do with level events. Not to be confused with events.
Warp functions:
http://wohlsoft.ru/pgewiki/Warp_(class)
Mainly functions and field values to do with warps. Not to be confused with events.
BGO functions:
http://wohlsoft.ru/pgewiki/BGO_(class)
Mainly functions and field values to do with BGOs. Not to be confused with events.
List of LunaLua examples:
http://wohlsoft.ru/pgewiki/LunaLua_Examples
Links to a handful of quality exemplars, featured on the PGE wiki.
List of LunaLua APIs:
http://wohlsoft.ru/pgewiki/Category:Lun ... _libraries
Global functions:
http://wohlsoft.ru/pgewiki/LunaLua_global_functions
All of your general, graphics, static item, text, and miscellaneous functions. Not to be confused with events.
Global sound and music functions:
http://wohlsoft.ru/pgewiki/LunaLua_glob ... _functions
All of your functions to do with music and sound effects. Not to be confused with events.
Events:
http://wohlsoft.ru/pgewiki/LunaLua_events
Both your overworld and level events. Always preceeded by "function". They trigger code written inside them whenever a certain time or other criteria is met.
API functions and events:
http://wohlsoft.ru/pgewiki/LunaLua_global_API_functions
An API, which is placed in Lua Scripts Lib, has certain characteristics and events that make it an API. These items are required for it to function. Refer to barebones.lua for more help info on API format.
Hardcoded image list:
http://wohlsoft.ru/pgewiki/Hardcoded_Im ... MBX_Engine
Certain SMBX graphics require Lua to be used, since they are built in farther than the normal graphics folder. Replacements of hardcoded images can be added to the custom graphics folder of a level or an episode to be used, but they must have the exact same name and dimensions (size).
Sound effects list:
http://wohlsoft.ru/pgewiki/SFX_list_(SMBX64)
The sound effects in the SMBX sounds folder are not in order. Use this list to find their IDs, which is needed for changing sounds in .ini's and for multiple sound effect functions.
Player offsets:
http://wohlsoft.ru/pgewiki/SMBX_Player_Offsets
The values held in memory to do with the player's state, actions, etc.
NPC offsets:
http://wohlsoft.ru/pgewiki/SMBX_NPC_Offsets
The values held in memory to do with the state of NPCs, their actions, etc.
NPC AIs:
http://wohlsoft.ru/pgewiki/SMBX_NPC_AI
Descriptors of the default AI of all NPCs.
NPC functions:
http://wohlsoft.ru/pgewiki/NPC_(class)
Mainly functions and field values to do with NPCs. Not to be confused with events.
Player functions:
http://wohlsoft.ru/pgewiki/Player_(class)
Mainly functions and field values to do with the player(s). Not to be confused with events.
Section functions:
http://wohlsoft.ru/pgewiki/Section_(class)
Mainly functions and field values to do with the section(s). Not to be confused with events.
Block functions:
http://wohlsoft.ru/pgewiki/Block_(class)
Mainly functions and field values to do with blocks. Not to be confused with events.
Animation functions:
http://wohlsoft.ru/pgewiki/Animation_(class)
Mainly functions and field values to do with graphical animations. Not to be confused with events.
Layer functions:
http://wohlsoft.ru/pgewiki/Layer_(class)
Mainly functions and field values to do with layers. Not to be confused with events.
Data functions:
http://wohlsoft.ru/pgewiki/Data_(class)
The functions, constructors, field values, and enums to do with saving data. Not to be confused with events.
Event functions:
http://wohlsoft.ru/pgewiki/Event_(class)
Mainly functions and field values to do with level events. Not to be confused with events.
Warp functions:
http://wohlsoft.ru/pgewiki/Warp_(class)
Mainly functions and field values to do with warps. Not to be confused with events.
BGO functions:
http://wohlsoft.ru/pgewiki/BGO_(class)
Mainly functions and field values to do with BGOs. Not to be confused with events.
List of LunaLua examples:
http://wohlsoft.ru/pgewiki/LunaLua_Examples
Links to a handful of quality exemplars, featured on the PGE wiki.
List of LunaLua APIs:
http://wohlsoft.ru/pgewiki/Category:Lun ... _libraries